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

Replace single- with double-quote for docstrings, as per PEP-257 #973

Merged
merged 1 commit into from
Jul 5, 2023

Conversation

fgebhart
Copy link
Contributor

@fgebhart fgebhart commented Jul 4, 2023

Related Issue(s):

Closes #319

Proposed Changes:

For inclusion in changelog (if applicable):

  1. Replacement of all single quotes by double quotes in docstrings.

Not intended for changelog:

  1. This PR replaces all occurrences of ''' with """ in order to comply with PEP-257 as outlined in change docstrings to triple quotes #319

Diff of User Interface

Old behavior: No diff

New behavior: No diff

PR Checklist:

  • This PR is as small and focused as possible
  • If this PR includes proposed changes for inclusion in the changelog, the title of this PR summarizes those changes and is ready for inclusion in the Changelog.
  • I have updated docstrings for function changes and docs in the 'docs' folder for user interface / behavior changes
  • This PR does not break any examples or I have updated them

(Optional) @mentions for Notifications:

Remark
I was looking for a small/easy issue to start with and found #319. However, after browsing through the code base, I couldn't find any docstrings that used only a single (opposed of triple) quote (please let me know if there are yet any and I simply overlooked them). Thus, technically the description of #319:

docstrings should use triple-quotes

is already fulfilled. However PEP-257 requires triple-double quotes

always use """triple double quotes""" around docstrings

which is why I took the liberty to tackle this exact specification in the scope of the linked issue. Basically, all I did was to find and replace ''' with """ throughout the code base.

Note, I would totally understand if you do not want to take care of such a cosmetic change.

Please review with care, as this is my first contribution to this repo. Thanks!

Copy link
Contributor

@sgillies sgillies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @fgebhart ! I couldn't find any sign of non-triple quotes used for docstrings, so my interpretation of the intent of #319 is "change docstrings to triple double-quotes".

I've switched the target branch to main.

@sgillies sgillies added this to the 2.1.0 milestone Jul 5, 2023
@sgillies sgillies changed the base branch from maint-2.0 to main July 5, 2023 19:08
@sgillies sgillies merged commit a3b27c1 into planetlabs:main Jul 5, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

change docstrings to triple quotes
2 participants