Perfect your code
With built-in code review tools, GitHub makes it easy to raise the quality bar before you ship. Join the 40 million developers who've merged over 200 million pull requests.
Sign up for free See pricing for teams and enterprisesbpo-22593: Automate update of Unicode data version in documentation #17748
Conversation
Thanks for the PR @nmassman and welcome! I agree with the general idea behind the PR, it doesn't seem practical to maintain the latest Unicode version in 6 different locations, or for additional ones that are added in the future. However, a few points (I might think of more later):
/cc @merwok |
This comment has been minimized.
This comment has been minimized.
Thanks for the feedback @aeros
I waffled on this a bit, but I went back and took another crack at it. Mostly I wanted to avoid having makeunicodedata.py accidentally mangle conf.py. I think I got it working reliably, though.
Kinda embarrassed that I didn't clean that up before submitting the PR. I should have slept first. :) I renamed everything to 'UNIDATA_VERSION' to match the original variable in makeunicodedata.py. This could just as easily be changed to 'UNICODE_VERSION', but I erred on the side of staying consistent to what was already in place.
I wasn't sure of the convention. I copied the heading format from what was in a few of the other sphinx extensions in the same directory. I inserted the bpo link instead (which was also in one of the other extensions), and updated the news entry. |
This comment has been minimized.
This comment has been minimized.
I think the comments in the file constitute a change log, not a copyright notice. The copyright situation is already handled by the CLA check, which ensures that the contribution has a suitable license. It seems OK to me to add a line there, even though there is external history in VCS metadata. |
nmassman commentedDec 30, 2019
•
edited by bedevere-bot
Added a sphinx extension and modified makeunicodedata.py to automate updating documentation with the current Unicode version when it changes.
https://bugs.python.org/issue22593