OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-04 13:13:25 +03:00
Code Activity

0029817: Documentation - avoid excessive use of "please"

Browse Source 
"Please" is now used in the documentation only in sensitive cases.
This commit is contained in:
ysn
2018-07-09 13:53:01 +03:00
committed by bugmaster
parent 3b7f55e9d1
commit 07f2b74116
15 changed files with 60 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
dox/dev_guides/documentation/documentation.md
View File

@@ -134,7 +134,7 @@ Add a relative path to *svn.md* in file <i>dox/FILES.txt</i>. For instance
dev_guides/svn/svn.md
@endverbatim
**Note** that the order of paths to documents in *FILES.txt* is reproduced in the Table of Contents in the HTML output. Please, place them logically.
**Note** that the order of paths to documents in *FILES.txt* is reproduced in the Table of Contents in the HTML output, thus they need to be placed logically.
**Note** that you should specify a file tag, not the document name. See @ref OCCT_DM_SECTION_A_1 "Header and hierarchic document structure" section for details.
@@ -180,7 +180,7 @@ For example:
@subsubsection occt_ocaf_1_1_1 The document and the data framework
@endverbatim
Please, note that section names can be used for references within the document and in other documents, so it is necessary to use the common prefix indicative of the document name for all section names in the given document.
**Note** that section names can be used for references within the document and in other documents, so it is necessary to use the common prefix indicative of the document name for all section names in the given document.
For example, *occt_ocaf* for sections in Open CASCADE Application Framework manual.
The remaining part of section names in most documents consists only of numbers, for example *1_1*. Actually, the hierarchical structure of the output table of contents is not based on these numbers and is generated automatically.