Skip to content

Commit 9f8bb84

Browse files
committed
Fix documentation typos and wording
1 parent 6ca4acf commit 9f8bb84

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/history.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Version 1.7.0
2929
3030
generator_path, generator_name = pygccxml.utils.find_xml_generator()
3131
32-
3. [CastXML] When using the configuration, you will need to tell pygccxml which xml genrator you are using.
32+
3. [CastXML] When using the configuration, you will need to tell pygccxml which xml generator you are using.
3333

3434
.. code-block:: python
3535
@@ -48,9 +48,9 @@ Version 1.7.0
4848

4949
This is done by using the ``compiler_path`` attribute in the configuration.
5050
Note that this may be important because the resulting xml file is slightly different
51-
depending on the used compiler.
51+
depending on the compiler.
5252

53-
5. [CastXML] Add support for some fields which have no location.
53+
5. [CastXML] Added support for some fields which have no location.
5454

5555
These fields are: ``gp_offset``, ``fp_offset``, ``overflow_arg_area``, ``reg_save_area``
5656

@@ -68,7 +68,7 @@ Version 1.7.0
6868

6969
9. [CastXML] Annotations:
7070

71-
Instead of using the ``__attribute((gccxml("string")))`` c++ syntax (see version 0.9.5), the ``__attribute__`` ((annotate ("out"))) can now be used to annotate code with CastXML.
71+
Instead of using the ``__attribute((gccxml("string")))`` c++ syntax (see version 0.9.5), the ``__attribute__ ((annotate ("out")))`` can now be used to annotate code with CastXML.
7272

7373
10. [CastXML] Disabled relinking of:
7474

@@ -77,26 +77,26 @@ Version 1.7.0
7777
rebind<std::__tree_node<std::basic_string<char>, void *> >
7878
7979
This made the ``find_container_traits_tester`` unit tests fail with ``CastXML``.
80-
This class defintion is present in clangs AST tree, but I don't know why it is
81-
usefull. Please tell us if you need it so we can re-enable that featur in pygccxml.
80+
This class defintion is present in the clang AST tree, but I don't know why it is
81+
usefull. Please tell me if you need it so we can re-enable that featur in pygccxml.
8282

83-
11. Deprecated the ``compiler`` attribute and replaced it with a global ``utils.xml_generator`` variable.
83+
11. [Misc] Deprecated the ``compiler`` attribute and replaced it with a global ``utils.xml_generator`` variable.
8484

8585
The ``compiler`` attribute was misleading; it was sometimes confused with the name and version of the xml generator.
8686

8787
This change also fixes some internal problems with the algorithms cache.
8888

89-
12. ``declarations.has_trivial_copy`` was defintevely removed.
89+
12. [Misc] ``declarations.has_trivial_copy`` was defintevely removed.
9090

9191
Please use ``declarations.has_copy_constructor``.
9292

9393
This was deprecated since version 0.9.5.
9494

95-
13. Remove ``gccxml`` logger from logger class (was deprecated).
95+
13. [Misc] Remove ``gccxml`` logger from logger class (was deprecated).
9696

9797
Please use ``cxx_parser`` instead.
9898

99-
14. Removed ``gccxml_runtime_error_t`` class. This was only used internally.
99+
14. [Misc] Removed ``gccxml_runtime_error_t`` class. This was only used internally.
100100

101101
Please use a normal ``RuntimeError`` instead.
102102

@@ -114,7 +114,7 @@ Version 1.7.0
114114

115115
19. [Misc] The compiler version debugging message is now hidden (closes #12)
116116

117-
20. [Misc] Print less line separations in decl_printer; this makes the output more compact.
117+
20. [Misc] Print less line separations in ``decl_printer``; this makes the output more compact.
118118

119119
21. [Tests] Add new test for the ``contains_parent_dir`` function.
120120

0 commit comments

Comments
 (0)