Skip to content

Commit 645988b

Browse files
author
roman_yakovenko
committed
improve documentation style
1 parent f25c60a commit 645988b

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/pygccxml.rest

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Only 1 ( one ) line of code is needed:
5656
#global_ns is the reference to declarations, which describes global( :: ) namespace
5757
global_ns.free_functions( "do_smth", return_type='void', arg_types=[None,'int'] )
5858
59-
``None`` means "any type". In my opinion the code is prety clear and readable.
59+
``None`` means "any type". In my opinion, the code is prety clear and readable.
6060

6161
If you want to know more about provided API read `query interface`__ document or
6262
API documentation.

docs/query_interface.rest

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ a reference to an integer. More over, I want those functions names to end with
2525
global_ns.member_functions( function=query, arg_types=[None, 'int &'] )
2626
2727
The example is complex, but still readable. In many cases you will find
28-
yourself looking for one or many declarations using one or two properties of that
29-
declaration(s). For example:
28+
yourself, looking for one or many declarations, using one or two declaration properties.
29+
For example:
3030
3131
.. code-block:: Python
3232

docs/upgrade_issues.rest

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ change the default value expression from the script:
199199
200200
#f is "calldef_t" instance
201201
for arg in f.arguments:
202-
arg.default_value = <new default value or None>
202+
arg.default_value = <<<new default value or None>>>
203203
204204
205205
-------------

0 commit comments

Comments
 (0)