-
Notifications
You must be signed in to change notification settings - Fork 799
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Documentation] Fix lowercase DLL names and standardize uppercase X
for variable version number
#2089
Conversation
@mhammond (and @vernondcole since it touches adodbapi documentation) thoughts? The Python version mentions would especially have made it much easier to search for outdated code in previous PRs. And help clarify certain comments. |
I'm fairly ambivalent about much of this. In particular, some of the DLL renames are moving away from what's on the file-system to all lower-case, and |
heh - yeah, I think I might have actually changed that semi-recently for our DLLs. I recall mapi used to have the mixed-case name somewhere, but that was long long ago, so I can't argue with evidence that I'm wrong about that, sorry. |
No worries, avoiding this kind of confusion about actual file names is a small reason why I'm opening this PR in the first place. With all the recent code cleanup in preparation for #2102 , I figured may as well do a pass of comments/doc cleanup for nitpicky things I've noticed along the way. I don't think you need to hard enforce those in the future or whatever. But rather may as well do it in a sweeping change. I think that accurate file names and mentioning "Python" (or py2k/py3k) along a standalone version number does have some (although slight) value. Namely making it easier to find areas of code that can be simplified when dropping support for a Python version. Or understanding at a glance, with certainty, that the version number is related to Python, not something else. Dropping Note, looking back at file changes, there is one code change, in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks - and yeah, the add_task changes already landed.
These are documentation-only changes, and more of a suggestion. Has some overlap with #1990 so it'll reduce changes there.
Standardised:
Example changes: