diff options
| author | Steve Piercy <web@stevepiercy.com> | 2016-11-20 21:58:43 -0800 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2016-11-20 21:58:43 -0800 |
| commit | c13e6cc241d1f52382435a56a18e791b6b9bbe1a (patch) | |
| tree | 6070f57ae68d8ee094c03aa14825b136838b7871 /docs | |
| parent | 2954362448347a6a3efd55222a50ece8e2fae6a0 (diff) | |
| download | pyramid-c13e6cc241d1f52382435a56a18e791b6b9bbe1a.tar.gz pyramid-c13e6cc241d1f52382435a56a18e791b6b9bbe1a.tar.bz2 pyramid-c13e6cc241d1f52382435a56a18e791b6b9bbe1a.zip | |
add links
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/style-guide.rst | 42 |
1 files changed, 26 insertions, 16 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst index 4a17e1d2b..911949862 100644 --- a/docs/style-guide.rst +++ b/docs/style-guide.rst @@ -139,6 +139,27 @@ Indentation - Do not use tabs to indent. +.. _style-guide-grammar-spelling-preferences: + +Grammar, spelling, and capitalization preferences +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Use any commercial or free professional style guide in general. Use a spell- and grammar-checker. The following table lists the preferred grammar, spelling, and capitalization of words and phrases for frequently used items in the documentation. + +========== ====================== +Preferred Avoid +========== ====================== +add-on addon +and so on etc. +GitHub Github, github +JavaScript Javascript, javascript +plug-in plugin +select check, tick (checkbox) +such as like +verify be sure +========== ====================== + + .. _style-guide-headings: Headings @@ -177,25 +198,14 @@ Paragraphs A paragraph should be on one line. Paragraphs must be separated by two line feeds. -.. _style-guide-grammar-spelling-preferences: +Links +^^^^^ -Grammar, spelling, and capitalization preferences -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Use inline links to keep the context or link label together with the URL. Do not use targets and links at the end of the page, because the separation makes it difficult to update and translate. Here is an example of inline links, our required method. -Use any commercial or free professional style guide in general. Use a spell- and grammar-checker. The following table lists the preferred grammar, spelling, and capitalization of words and phrases for frequently used items in the documentation. + .. code-block:: rst -========== ====================== -Preferred Avoid -========== ====================== -add-on addon -and so on etc. -GitHub Github, github -JavaScript Javascript, javascript -plug-in plugin -select check, tick (checkbox) -such as like -verify be sure -========== ====================== + `Example <http://example.com>`_ |