Skip to content

add example code for python docstrings tutorial #685

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add example code for python docstrings tutorial #685

wants to merge 2 commits into from
+238 −0

Conversation

Lonercode
Copy link
Contributor

Where to put new files:

  • New files should go into a top-level subfolder, named after the article slug. For example: my-awesome-article

How to merge your changes:

  1. Make sure the CI code style tests all pass (+ run the automatic code formatter if necessary).
  2. Find an RP Team member on Slack and ask them to review & approve your PR.
  3. Once the PR has one positive ("approved") review, GitHub lets you merge the PR.
  4. 🎉

@Lonercode Lonercode requested a review from acsany July 10, 2025 17:37
carlosr301101
carlosr301101 reviewed Jul 11, 2025
View reviewed changes
Copy link

@carlosr301101 carlosr301101 left a comment

Choose a reason for hiding this comment

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

Hi, hope this review help someone.

python-docstrings/doctest_style.py Outdated
>>> undo_spell("Lumos")
"somuL"
"""
return spell[::1]
Copy link

Choose a reason for hiding this comment

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

Hi, returning spell[::1] gives the same word.
The correct way:
return spell[::-1]

Copy link
Contributor Author

@Lonercode Lonercode Jul 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

That's right. wow. Thanks. It was an oversight on my part. I'll fix it.

carlosr301101
carlosr301101 reviewed Jul 19, 2025
View reviewed changes
Copy link

@carlosr301101 carlosr301101 left a comment

Choose a reason for hiding this comment

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

Very helpful and good description of different docstring formats

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carlosr301101 carlosr301101 carlosr301101 left review comments

@acsany acsany Awaiting requested review from acsany

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Lonercode @carlosr301101