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

Update docstrings section for clarity and fix code sample indentation #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cdcme
Copy link

@cdcme cdcme commented Feb 3, 2016

ReStructured Text is typically abbreviated as RST, not reST, so I've changed that here since reST is too much like REST. I've also added a parenthetical spelling out what RST stands for for clarity and fixed the indentation in the code sample.

ReStructured Text is typically abbreviated as RST, not reST, so I've changed that here since reST is too much like REST. I've also added a parenthetical spelling out what RST stands for for clarity and fixed the indentation in the code sample.
@dirn
Copy link

dirn commented Apr 10, 2017

reST and RST are both acceptable abbreviations. I've personally always preferred the former as it better reflects the style of reStructuredText.

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.

None yet

3 participants