File tree Expand file tree Collapse file tree 1 file changed +4
-4
lines changed Expand file tree Collapse file tree 1 file changed +4
-4
lines changed Original file line number Diff line number Diff line change 26
26
27
27
# --------------------- NOTES TO CONTRIBUTORS -----------------------
28
28
# Markdown in mkdocs
29
- # 01. Redering concatenates across single line breaks. This means...
29
+ # 01. Rendering concatenates across single line breaks. This means...
30
30
# A. We have to be careful to add extra line breaks around paragraphs,
31
- # including between the end of a pgf and the beginnign of bullets.
31
+ # including between the end of a pgf and the beginning of bullets.
32
32
# B. We can use hard wrapping to make github reviews easier to read.
33
33
# VSCode Rewrap extension offers a keyboard shortcut for hard wrap
34
- # at the ruler, but don't add breaks in [multiword links](example.com)
34
+ # at the ruler, but don't add breaks in [multi-word links](example.com)
35
35
# 02. Instead of designating codeblocks with bash, use console. For example..
36
36
# ```console
37
37
# cd ../my_dir
57
57
# 02. Site analytics depend on a local environment variable GOOGLE_ANALYTICS_KEY
58
58
# You can find this in LastPass or declare with any string to suppress errors
59
59
# 03. The API section will pull docstrings.
60
- # A. Follow google styleguide e.g.,
60
+ # A. Follow google style guide e.g.,
61
61
# https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
62
62
# With typing suggestions: https://docs.python.org/3/library/typing.html
63
63
# B. To pull a specific workflow fork, change ./docs/src/api/make_pages.py#L19
You can’t perform that action at this time.
0 commit comments