From 8122c18944b69305060b03fad5b5a46ca59c0975 Mon Sep 17 00:00:00 2001 From: gritbub <38131016+gritbub@users.noreply.github.com> Date: Fri, 18 May 2018 17:26:51 -0500 Subject: Rephrase documentation - typos, grammatical nuance, and links --- doc/references/CodingStyle.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/references/CodingStyle.rst') diff --git a/doc/references/CodingStyle.rst b/doc/references/CodingStyle.rst index 3c9b9f398..2fb09c6ef 100644 --- a/doc/references/CodingStyle.rst +++ b/doc/references/CodingStyle.rst @@ -12,9 +12,9 @@ We try to follow the 'GNU Coding Standards' when possible: comments before declarations, two spaces at end of sentences, finish sentences with a dot. But: 3 spaces for indentation. -No trailing spaces, not TAB (HT). +No trailing spaces, no TAB (HT). -Subprograms must have a comment before to describe it, like: +Subprograms must have a comment before to describe them, like: .. code-block:: Ada @@ -74,9 +74,9 @@ declaration). Don't repeat the comment before the subprogram body. Loc : Iir) return O_Enode - 7) If not possible, ask yourself what is wrong! Shorten a name. + 7. If not possible, ask yourself what is wrong! Shorten a name. -* Rule for the 'is': one a new line only if the declarative part is not empty: +* Rule for the 'is': on a new line only if the declarative part is not empty: .. code-block:: Ada @@ -92,7 +92,7 @@ declaration). Don't repeat the comment before the subprogram body. function Translate_Static_Range_Dir (Expr : Iir) return O_Cnode is begin - If the parametere line is too long with the 'is', put in on a separate line: + If the parameter line is too long with the 'is', put in on a separate line: .. code-block:: Ada -- cgit v1.2.3 From 2f3242a4e3487d75b31101d65c2df114eefaf7e4 Mon Sep 17 00:00:00 2001 From: gritbub <38131016+gritbub@users.noreply.github.com> Date: Mon, 4 Jun 2018 20:03:46 -0500 Subject: Standardize indentation to 2 spaces Change indentation within documentation code blocks to 2 space indents instead of 3. --- doc/references/CodingStyle.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/references/CodingStyle.rst') diff --git a/doc/references/CodingStyle.rst b/doc/references/CodingStyle.rst index 2fb09c6ef..b9da53804 100644 --- a/doc/references/CodingStyle.rst +++ b/doc/references/CodingStyle.rst @@ -10,7 +10,7 @@ Use assertions. We try to follow the 'GNU Coding Standards' when possible: comments before declarations, two spaces at end of sentences, finish sentences with a dot. -But: 3 spaces for indentation. +But: 2 spaces for indentation in code blocks. No trailing spaces, no TAB (HT). @@ -82,7 +82,7 @@ declaration). Don't repeat the comment before the subprogram body. procedure Translate_Assign (Target : Mnode; Expr : Iir; Target_Type : Iir) is - Val : O_Enode; + Val : O_Enode; begin vs. @@ -130,9 +130,9 @@ declaration). Don't repeat the comment before the subprogram body. .. code-block:: Ada is - N_Info : constant Iir := Get_Sub_Aggregate_Info (Info); - Assoc : Iir; - Sub : Iir; + N_Info : constant Iir := Get_Sub_Aggregate_Info (Info); + Assoc : Iir; + Sub : Iir; begin If the initialization expression has a side effect (such as allocation), do -- cgit v1.2.3 From 0490a02c0982962c944e3b8eb7ded090e18e403b Mon Sep 17 00:00:00 2001 From: gritbub <38131016+gritbub@users.noreply.github.com> Date: Tue, 5 Jun 2018 05:59:23 -0500 Subject: Reduce after-sentence spacing to one space During PR 591 it was decided that all sentences should be ended with a period and then followed by only one space. Regex changed 132 instances of two spaces to one space (in 7 files). Also changed the second paragraph of CodingStyle to dictate the use of one space instead of two. --- doc/references/CodingStyle.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/references/CodingStyle.rst') diff --git a/doc/references/CodingStyle.rst b/doc/references/CodingStyle.rst index b9da53804..6af869067 100644 --- a/doc/references/CodingStyle.rst +++ b/doc/references/CodingStyle.rst @@ -4,12 +4,12 @@ Coding Style ############ Ada subset: use only a simple (VHDL like) subset of Ada: no tasking, no -controlled types... VHDL users should easily understand that subset. +controlled types... VHDL users should easily understand that subset. Allowed Ada95 features: the standard library, child packages. Use assertions. We try to follow the 'GNU Coding Standards' when possible: comments before -declarations, two spaces at end of sentences, finish sentences with a dot. +declarations, one space at the end of sentences, finish sentences with a dot. But: 2 spaces for indentation in code blocks. No trailing spaces, no TAB (HT). @@ -22,7 +22,7 @@ Subprograms must have a comment before to describe them, like: procedure Sem_Concurrent_Statement_Chain (Parent : Iir); The line before the comment must be a blank line (unless this is the first -declaration). Don't repeat the comment before the subprogram body. +declaration). Don't repeat the comment before the subprogram body. * For subprograms: -- cgit v1.2.3