Skip to content
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

Fixup: update function name in docs to match source #1997

Merged
merged 2 commits into from Feb 22, 2021
Merged

Fixup: update function name in docs to match source #1997

merged 2 commits into from Feb 22, 2021

Conversation

jayaddison
Copy link
Contributor

Considerations to bear in mind when deciding whether to rename this function:

  • It has recently been renamed (neither a plus nor minus for renaming again, necessarily)
  • It is a public method, by naming convention (makes renaming it slightly less attractive)
  • It refers in a strict-ish sense to right-hand-side line splits (so perhaps it could be renamed further; this is mitigated by a variable rename)

Resolves #1996

@jayaddison jayaddison changed the title Documentation fixup/split method naming Fixup: update function name in docs to match source Feb 22, 2021
@ichard26
Copy link
Collaborator

ichard26 commented Feb 22, 2021

I mean, I'm not 100% approving this, but since we don't provide a stable Python API, modifying internals like this is fair game IMO. Other core team members may have a different viewpoint.

@ichard26 ichard26 added the T: documentation Improvements to the docs (e.g. new topic, correction, etc) label Feb 22, 2021
@JelleZijlstra
Copy link
Collaborator

Sounds like we should at least do this to unbreak the docs build?

@ichard26
Copy link
Collaborator

Sounds like we should at least do this to unbreak the docs build?

Yeah I agree on second thought, somehow I ignored that was failing and this is the fix.

@JelleZijlstra JelleZijlstra merged commit fe4a9d6 into psf:master Feb 22, 2021
@jayaddison jayaddison deleted the documentation-fixup/split-method-naming branch February 22, 2021 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Continuous integration: documentation generation failure due to mismatched reference function name
3 participants