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.

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

Normalize use of text styles in docstrings #334

Closed
kgriffs opened this issue Oct 10, 2014 · 2 comments · Fixed by #427
Closed

Normalize use of text styles in docstrings #334

kgriffs opened this issue Oct 10, 2014 · 2 comments · Fixed by #427
Milestone
0.2.0

Comments

@kgriffs
Copy link
Member

kgriffs commented Oct 10, 2014

TBD, but current thoughts:

  • For types, use double-backticks
  • For referencing methods or params, use single-backticks
@kgriffs kgriffs added this to the 0.2.0 milestone Oct 10, 2014
@kgriffs
Copy link
Member Author

kgriffs commented Dec 1, 2014

Double-backticks

  • Inline code
  • Variables
  • Types
  • Decorators

Single-backticks

  • Methods
  • Params
  • Attributes

@kgriffs kgriffs self-assigned this Dec 6, 2014
@kgriffs
Copy link
Member Author

kgriffs commented Dec 6, 2014

IMO this would be good to add to CONTRIBUTING.md

@kgriffs kgriffs modified the milestones: 0.3, 0.2.0 Jan 12, 2015
@kgriffs kgriffs modified the milestones: 0.2.0, 0.3 Jan 26, 2015
kgriffs pushed a commit to kgriffs/falcon that referenced this issue Jan 30, 2015
Standardize docstring syntax
31a05b0 
Unify the use of markup in docstrings, particulary relating to the use of
backticks and asterisks. Also clean up any remaining minor inconsistencies or
errors in the docstrings.

Closes falconry#334
kgriffs pushed a commit to kgriffs/falcon that referenced this issue Jan 30, 2015
doc(reference): Standardize docstring syntax
c907f4b 
Unify the use of markup in docstrings, particulary relating to the use of
backticks and asterisks. Also clean up any remaining minor inconsistencies or
errors in the docstrings.

Closes falconry#334
@kgriffs kgriffs mentioned this issue Jan 30, 2015
Merged
kgriffs pushed a commit to kgriffs/falcon that referenced this issue Feb 4, 2015
doc(reference): Standardize docstring syntax
d7118aa 
Unify the use of markup in docstrings, particulary relating to the use of
backticks and asterisks. Also clean up any remaining minor inconsistencies or
errors in the docstrings.

Closes falconry#334
kgriffs pushed a commit to kgriffs/falcon that referenced this issue Feb 4, 2015
doc(reference): Standardize docstring syntax
da2bc23 
Unify the use of markup in docstrings, particulary relating to the use of
backticks and asterisks. Also clean up any remaining minor inconsistencies or
errors in the docstrings.

Closes falconry#334
@kgriffs kgriffs removed their assignment Oct 12, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.2.0
Development

Successfully merging a pull request may close this issue.

doc(reference): Standardize docstring syntax kgriffs/falcon
1 participant
@kgriffs