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

Added Markup section. #121

Merged
merged 5 commits into from
Dec 7, 2021
Merged

Added Markup section. #121

merged 5 commits into from
Dec 7, 2021

Conversation

FernandoDavis
Copy link
Contributor

Includes special cases and extra information. Fixed minor mistakes in the style guide.

@FernandoDavis FernandoDavis linked an issue Dec 5, 2021 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Dec 5, 2021

Codecov Report

Merging #121 (28d8bce) into main (9438cf5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #121   +/-   ##
=======================================
  Coverage   90.89%   90.89%           
=======================================
  Files          42       42           
  Lines        2997     2997           
=======================================
  Hits         2724     2724           
  Misses        273      273           
Flag Coverage Δ
unittests 90.89% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9438cf5...28d8bce. Read the comment docs.

@bwohlberg bwohlberg added developer Developer environment: issues related to CI, git, etc. documentation Improvements or additions to documentation labels Dec 6, 2021
- Variable, module, function, and class names:
Should be written in between single back-ticks (`x`).
- None and NoneType:
Should be written in between double back-ticks (``None``).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps None, NoneType, True, and False?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added!

@bwohlberg bwohlberg merged commit f5a18cb into main Dec 7, 2021
@bwohlberg bwohlberg deleted the FernandoDavis/Style_Guide_markups branch December 7, 2021 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer Developer environment: issues related to CI, git, etc. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Notes on docstring markup missing in style guide
2 participants