[pygccxml-commit] SF.net SVN: pygccxml:[1393] pyplusplus_dev/docs
Brought to you by:
mbaas,
roman_yakovenko
From: <rom...@us...> - 2008-08-14 07:31:27
|
Revision: 1393 http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1393&view=rev Author: roman_yakovenko Date: 2008-08-14 07:31:30 +0000 (Thu, 14 Aug 2008) Log Message: ----------- documentation changes: replace "next" with "the following" Modified Paths: -------------- index.rest pygccxml_dev/docs/design.rest pygccxml_dev/docs/download.rest pygccxml_dev/docs/pygccxml.rest pygccxml_dev/docs/query_interface.rest pygccxml_dev/docs/upgrade_issues.rest pyplusplus_dev/docs/comparisons/pyste.rest pyplusplus_dev/docs/documentation/architecture.rest pyplusplus_dev/docs/documentation/containers.rest pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest pyplusplus_dev/docs/documentation/ctypes/unions.rest pyplusplus_dev/docs/documentation/functions/call_policies.rest pyplusplus_dev/docs/documentation/functions/default_args.rest pyplusplus_dev/docs/documentation/functions/overloading.rest pyplusplus_dev/docs/documentation/functions/registration_order.rest pyplusplus_dev/docs/documentation/functions/transformation/inout.rest pyplusplus_dev/docs/documentation/functions/transformation/input.rest pyplusplus_dev/docs/documentation/functions/transformation/input_c_buffer.rest pyplusplus_dev/docs/documentation/functions/transformation/input_static_array.rest pyplusplus_dev/docs/documentation/functions/transformation/modify_type.rest pyplusplus_dev/docs/documentation/functions/transformation/name_mangling.rest pyplusplus_dev/docs/documentation/functions/transformation/output.rest pyplusplus_dev/docs/documentation/functions/transformation/output_static_array.rest pyplusplus_dev/docs/documentation/functions/transformation/transfer_ownership.rest pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest pyplusplus_dev/docs/documentation/how_to/absolute_relative_paths.rest pyplusplus_dev/docs/documentation/how_to/best_practices.rest pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest pyplusplus_dev/docs/documentation/how_to/templates.rest pyplusplus_dev/docs/documentation/inserting_code.rest pyplusplus_dev/docs/documentation/multi_module_development.rest pyplusplus_dev/docs/documentation/properties.rest pyplusplus_dev/docs/documentation/split_module.rest pyplusplus_dev/docs/documentation/warnings.rest pyplusplus_dev/docs/download.rest pyplusplus_dev/docs/examples/boost/boost.rest pyplusplus_dev/docs/history/history.rest pyplusplus_dev/docs/peps/dsl_challenge.rest pyplusplus_dev/docs/pyplusplus.rest pyplusplus_dev/docs/quotes.rest pyplusplus_dev/docs/troubleshooting_guide/easy_extending_guide/easy_extending_guide.rest pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest Modified: index.rest =================================================================== --- index.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ index.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -38,7 +38,7 @@ --------------- `Boost`_ provides free peer-reviewed portable C++ source libraries. `pyboost`_ -package export next libraries to Python: +package export the following libraries to Python: * `Boost.Date_Time`_ - date time library designed to provide a basis for performing efficient time calculations Modified: pygccxml_dev/docs/design.rest =================================================================== --- pygccxml_dev/docs/design.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pygccxml_dev/docs/design.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -184,7 +184,7 @@ ``file_configuration_t`` - a class, that contains some data and description how -to treat the data. ``file_configuration_t`` can contain reference to the next types +to treat the data. ``file_configuration_t`` can contain reference to the the following types of data: (1) path to C++ source file Modified: pygccxml_dev/docs/download.rest =================================================================== --- pygccxml_dev/docs/download.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pygccxml_dev/docs/download.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -58,7 +58,7 @@ pygccxml -------- In command prompt or shell change current directory to be "pygccxml-X.Y.Z". -"X.Y.Z" is version of `pygccxml`_. Type next command: +"X.Y.Z" is version of `pygccxml`_. Type the following command: | ``python setup.py install`` Modified: pygccxml_dev/docs/pygccxml.rest =================================================================== --- pygccxml_dev/docs/pygccxml.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pygccxml_dev/docs/pygccxml.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -39,7 +39,7 @@ Query interface --------------- `pygccxml`_ provides simple and powerful API to query declarations tree. How many -lines is needed to write next query? +lines is needed to write the following query? :: select all free functions from the project Modified: pygccxml_dev/docs/query_interface.rest =================================================================== --- pygccxml_dev/docs/query_interface.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pygccxml_dev/docs/query_interface.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -38,7 +38,7 @@ User interface -------------- -As you already know, ``pygccxml.declarations`` package defines next classes: +As you already know, ``pygccxml.declarations`` package defines the following classes: * ``scopedef_t`` - base class for all classes, that can contain other declarations @@ -205,7 +205,7 @@ }; ``clone`` member function `call policies`_ is ``return_value_policy<manage_new_object>()``. -Next code applies the `call policies`_ on all ``clone`` member functions within the +The following code applies the `call policies`_ on all ``clone`` member functions within the project: .. code-block:: Python @@ -216,7 +216,7 @@ Another example, from `Py++`_ project. Sometimes it is desirable to -exclude declaration, from being exported to Python. Next code will exclude +exclude declaration, from being exported to Python. The following code will exclude ``clone`` member function from being exported: .. code-block:: Python @@ -226,7 +226,7 @@ As you can see this class allows you to write less code. Basically using this class you don't have to write loops. If will do it for you. Also if you insist to write loops, ``mdecl_wrapper_t`` class implements ``__len__``, ``__getitem__`` -and ``__iter__`` methods. So you can write next code: +and ``__iter__`` methods. So you can write the following code: .. code-block:: Python Modified: pygccxml_dev/docs/upgrade_issues.rest =================================================================== --- pygccxml_dev/docs/upgrade_issues.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pygccxml_dev/docs/upgrade_issues.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -99,7 +99,7 @@ ------------------------------------------ Both versions of GCC-XML have a few issues, related to default arguments. GCC-XML 0.9 -fixes some issues, but introduces another ones. Take a look on next examples: +fixes some issues, but introduces another ones. Take a look on the following examples: * .. code-block:: C++ @@ -209,7 +209,7 @@ GCC-XML 0.9 mangles names different than the previous one. This change is the most dramatic one, because it may require from you to change the code. -Consider next C++ code: +Consider the following C++ code: .. code-block:: C++ Modified: pyplusplus_dev/docs/comparisons/pyste.rest =================================================================== --- pyplusplus_dev/docs/comparisons/pyste.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/comparisons/pyste.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -198,9 +198,9 @@ void do_smth(expensive_to_copy* x, const expensive_to_copy& y){ - //Pyste generates next code + //Pyste generates the following code //call_method< void >(self, "do_smth", x, y); - //Py++ generates next code + //Py++ generates the following code *this->get_override("do_smth")( boost::python::ptr(x), boost::ref(y) ); //------------------------------^^^^^^^^^^^^^^^^^^-----^^^^^^^^^^ } @@ -290,7 +290,7 @@ Features list ------------- `Py++`_ supports almost all features `Pyste`_ implements. `Py++`_, -version 0.8.0, does not implements next functionality, implemented by `Pyste`_: +version 0.8.0, does not implements the following functionality, implemented by `Pyste`_: * *pow* operator @@ -324,7 +324,7 @@ ------------------ Both `Pyste`_ and `Py++`_ generate working code. As we already saw in some -cases `Py++`_ do better job. `Py++`_ allows next customization on +cases `Py++`_ do better job. `Py++`_ allows the following customization on generated code: * To define std and user directories. *include_t* code creator will take @@ -409,7 +409,7 @@ This comparison was a little unfair. First of all `Pyste`_ is no more under active development\\support. Second, `Pyste`_ has been written 2 years ago and -had different goal. Next definitions will help you to understand the main +had different goal. The following definitions will help you to understand the main difference between `Pyste`_ and `Py++`_. `Pyste`_ Modified: pyplusplus_dev/docs/documentation/architecture.rest =================================================================== --- pyplusplus_dev/docs/documentation/architecture.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/architecture.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -26,7 +26,7 @@ On the earlier stage of the development, I realized, that all this functionality does not belong to code generator and should be implemented out side of it. `pygccxml`_ project was born. `pygccxml`_ made the code generator to be smaller -and C++ parser independent. It provides next services: +and C++ parser independent. It provides the following services: * definition of classes, that describe C++ declaration and types, and their analyzers ( type traits ) @@ -82,7 +82,7 @@ wrapping or hiding the API will not provide an additional value. The interface of all those services is pretty simple and well polished. -Before I explain how these services are integrated, take a look on next source +Before I explain how these services are integrated, take a look on the following source code: .. code-block:: Python @@ -111,7 +111,7 @@ good, it makes a lot of sense to configure the code generation engine, using the declarations tree. How does `Py++`_ add missing functionality to ``pygccxml.declarations`` classes? There were few possible solutions to the -problem. The next one was implemented: +problem. The following one was implemented: 1. ``pygccxml.parser`` package interface was extended. Instead of creating a concrete instance of declaration classes, ``pygccxml.parser`` package uses @@ -129,7 +129,7 @@ * the functionality provided by ``pygccxml.declarations`` and ``pygccxml.parser`` packages is available for ``pyplusplus.decl_wrappers`` classes -* classes defined in ``pyplusplus.decl_wrappers`` package implement next +* classes defined in ``pyplusplus.decl_wrappers`` package implement the following functionality: * setting reasonable defaults for the code generation engine( call policies, @@ -161,7 +161,7 @@ ----------------- Do you know how many ways exist to export member function? If you will try to -answer the question, consider next function characteristics and their mix: +answer the question, consider the following function characteristics and their mix: * virtuality( non virtual, virtual or pure virtual ) @@ -243,7 +243,7 @@ ~~~~~~~~~~~~~~~~~~~~~~ ``code_creators.module_t`` class is a top level ``code creator``. Take a look on -next possible "snapshot" of the ``code creators tree``: +the following possible "snapshot" of the ``code creators tree``: :: @@ -296,7 +296,7 @@ ---------------- ``File writers`` classes are responsible for writing ``code creators tree`` into -the files. `Py++`_ implements next strategies of writing ``code creators tree`` +the files. `Py++`_ implements the following strategies of writing ``code creators tree`` into files: * single file Modified: pyplusplus_dev/docs/documentation/containers.rest =================================================================== --- pyplusplus_dev/docs/documentation/containers.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/containers.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -40,7 +40,7 @@ `Boost.Python`_ mailing list or `documentation`_ for the new indexing suite. -Now, I am sure you have next question: if this suite is so good, why it is not +Now, I am sure you have the following question: if this suite is so good, why it is not in the main branch? The short answer is that this suite has some problems on MSVC 6.0 compiler and there are few users, that still use that compiler. The long answer is here: @@ -77,7 +77,7 @@ ------------------- By default, `Py++`_ works with built-in indexing suite. If you want to use -next version of indexing suite, you should tell this to the ``module_builder_t.__init__`` +indexing suite version 2, you should tell this to the ``module_builder_t.__init__`` method: .. code-block:: Python @@ -102,7 +102,7 @@ `Py++`_ defines ``indexing_suite1_t`` class. This class allows configure any detail of generated code: -* ``no_proxy`` - a boolean, if ``value_type`` is one of the next types +* ``no_proxy`` - a boolean, if ``value_type`` is one of the the following types * fundamental type @@ -119,11 +119,11 @@ * ``element_type`` - is a reference to container ``value_type`` or ``mapped_type``. -Next version of indexing suite API +Indexing suite version 2 API ---------------------------------- In this case there is no single place, where you can configure exported container -functionality. Please take a look on next C++ code: +functionality. Please take a look on the following C++ code: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest =================================================================== --- pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -77,7 +77,7 @@ ----------------- The functionality is going to be developed father and I intend to add -next features: +the following features: * to port this functionality to 64bit systems Modified: pyplusplus_dev/docs/documentation/ctypes/unions.rest =================================================================== --- pyplusplus_dev/docs/documentation/ctypes/unions.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/ctypes/unions.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -20,7 +20,7 @@ Example -------- -For this example I am going to use next code: +For this example I am going to use the following code: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/functions/call_policies.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/call_policies.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/call_policies.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -432,7 +432,7 @@ `Boost.Python`_ call policies are stateless classes, which do not care any information about the invoked function or object. In out case we have to pass -next information: +dependency_libraries information: * the size of array @@ -451,7 +451,7 @@ * default constructor -* call operator with next signature: +* call operator with the following signature: .. code-block:: C++ @@ -462,7 +462,7 @@ Pay attention: this operator will be invoked **after** the function. This call policy is **not thread-safe**! -For our case, next class could be defined: +For our case, the following class could be defined: .. code-block:: C++ @@ -490,7 +490,7 @@ ... }; -Next "get size" class treats this situation: +The following "get size" class treats this situation: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/functions/default_args.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/default_args.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/default_args.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -9,7 +9,7 @@ ------------ There is more than one way to export function with default arguments. Before we -proceed, please take a look on next class: +proceed, please take a look on the following class: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/functions/overloading.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/overloading.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/overloading.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -11,7 +11,7 @@ Things get a little bit complex, when you have to export overloaded functions. In general the solution is to explicitly say to compiler what function you want to export, by specifying its type. Before we proceed, please take a look -on next class: +on the following class: .. code-block:: C++ @@ -76,11 +76,11 @@ Overloaded template function ---------------------------- -I am sure you already know next fact, but still I want to remind it: +I am sure you already know the following fact, but still I want to remind it: * `GCC-XML`_ doesn't report about un-instantiated templates -It is very important to understand it. Lets take a look on next source code: +It is very important to understand it. Lets take a look on the following source code: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/functions/registration_order.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/registration_order.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/registration_order.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -64,7 +64,7 @@ Registration order pitfalls --------------------------- -Do you want to guess what is the output of the next program: +Do you want to guess what is the output of the following program: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/inout.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/inout.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/inout.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -34,7 +34,7 @@ Lets say that you need to expose ``hello_world`` function. As you know ``std::string`` is mapped to `Python`_ string, which is immutable type, so you -have to create small wrapper for the function. Next `Py++`_ code does it for you: +have to create small wrapper for the function. The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/input.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/input.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/input.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -28,7 +28,7 @@ Lets say that you need to expose ``hello_world`` function. As you know ``std::string`` is mapped to `Python`_ string, which is immutable type, so you -have to create small wrapper for the function. Next `Py++`_ code does it for you: +have to create small wrapper for the function. The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/input_c_buffer.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/input_c_buffer.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/input_c_buffer.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -26,8 +26,8 @@ void write( char* buffer, int size ) const; }; -In order to expose ``write`` member function we need to create small wrapper: -Next `Py++`_ code does it for you: +In order to expose ``write`` member function we need to create small wrapper. +The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/input_static_array.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/input_static_array.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/input_static_array.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -34,7 +34,7 @@ }; In order to expose ``init`` member function we need to create small wrapper: -Next `Py++`_ code does it for you: +The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/modify_type.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/modify_type.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/modify_type.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -38,7 +38,7 @@ Lets say that you need to expose ``hello_world`` function. As you know ``std::string`` is mapped to `Python`_ string, which is immutable type, so you -have to create small wrapper for the function. Next `Py++`_ code does it for you: +have to create small wrapper for the function. The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/name_mangling.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/name_mangling.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/name_mangling.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -18,7 +18,7 @@ I am sure you want to ask why and where `Py++`_ uses name mangling? `Py++`_ uses name mangling to create function-wrappers for overloaded and\\or free functions. -Consider next use case: +Consider the following use case: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/functions/transformation/output.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/output.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/output.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -30,7 +30,7 @@ Lets say that you need to expose ``hello_world`` function. As you know ``std::string`` is mapped to `Python`_ string, which is immutable type, so you -have to create small wrapper for the function. Next `Py++`_ code does it for you: +have to create small wrapper for the function. The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/output_static_array.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/output_static_array.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/output_static_array.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -32,8 +32,8 @@ int x,y,z; }; -In order to expose ``get_values`` member function we need to create small wrapper: -Next `Py++`_ code does it for you: +In order to expose ``get_values`` member function we need to create small wrapper. +The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/transfer_ownership.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/transfer_ownership.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/transfer_ownership.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -34,7 +34,7 @@ Lets say that you need to expose "do_smth" function. According to the FAQ, you have to create small wrapper, which will take ``std::auto_ptr`` as an argument. -Next `Py++`_ code does it for you: +The following `Py++`_ code does it for you: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -65,7 +65,7 @@ mb = module_builder.module_builder_t( ... ) get_size = mb.mem_fun( 'image_t::get_size' ) get_size.add_transformation( FT.output(0), FT.output(1) ) - #Next line has same effect + #the following line has same effect get_size.add_transformation( FT.output('width'), FT.output('height') ) `Py++`_ will generate a code, very similar to one found in Modified: pyplusplus_dev/docs/documentation/how_to/absolute_relative_paths.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/absolute_relative_paths.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/how_to/absolute_relative_paths.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -4,8 +4,7 @@ **Absolute\\relative paths** -Consider next fileers, the average number of characters per line is -less than 2. Please cs layout: +Consider the following layout: :: boost/ Modified: pyplusplus_dev/docs/documentation/how_to/best_practices.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/best_practices.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/how_to/best_practices.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -58,7 +58,7 @@ come to conclusion, that in order to improve compilation speed, user should be able to control( to be able to generate ) precompiled header file. He implemented an initial version of the functionality. After small discussion, - we agreed on next interface: + we agreed on the following interface: .. code-block:: Python @@ -86,7 +86,7 @@ * **Caveats** - Consider next file layout: + Consider the following file layout: :: boost/ @@ -101,7 +101,7 @@ .. code-block:: Python - #Next code will expose nothing + #the following code will expose nothing mb = module_builder( [ 'date_time/date_time.hpp' ], ... ) #while this one will work as expected Modified: pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -34,7 +34,7 @@ mb = module_builder_t( ... ) holder = mb.class_( 'holder< int >' ) holder.alias = 'IntHolder' - #next line has same effect as the previous one: + #the following line has same effect as the previous one: holder.rename( 'IntHolder' ) Another solution to the problem, is to use different strategy to split the generated Modified: pyplusplus_dev/docs/documentation/how_to/templates.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/templates.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/how_to/templates.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -8,7 +8,7 @@ Introduction ------------ -I would like to introduce next piece of code I will use for most exlanations. +I would like to introduce the following piece of code. I am going to use it for most exlanations. .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/inserting_code.rest =================================================================== --- pyplusplus_dev/docs/documentation/inserting_code.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/inserting_code.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -16,7 +16,7 @@ Insert code to module --------------------- -Almost every ``Boost.Python`` module has next structure: +Almost every ``Boost.Python`` module has the following structure: .. code-block:: C++ @@ -58,7 +58,7 @@ -------------------- ``class_t`` declaration defines few methods, which add user code to the generated one. -Lets take a look on next use case: +Lets take a look on the following use case: .. code-block:: C++ @@ -119,7 +119,7 @@ win = window_t( ) height, width = win.get_size() - If you will pass ``works_on_instance=False`` next code will be generated: + If you will pass ``works_on_instance=False`` the following code will be generated: .. code-block:: C++ @@ -153,13 +153,13 @@ ---------------------------- There are use cases, when you have to add code to `class wrapper`_. Please take a -look on next thread: http://mail.python.org/pipermail/c++-sig/2006-June/010791.html . +look on the following thread: http://mail.python.org/pipermail/c++-sig/2006-June/010791.html . .. _`class wrapper` : http://boost.org/libs/python/doc/tutorial/doc/html/python/exposing.html#python.class_virtual_functions -The short description is next: there are classes with parent/child relationship. +The short description is the following: there are classes with parent/child relationship. Parent keeps child class instances using raw pointer. When parent die, it also destroys children classes. It is not an option to switch to ``boost::shared_ptr``. Modified: pyplusplus_dev/docs/documentation/multi_module_development.rest =================================================================== --- pyplusplus_dev/docs/documentation/multi_module_development.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/multi_module_development.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -70,7 +70,7 @@ mb_core.build_code_creator( 'png' ) mb.write_module( 'png.cpp' ) -`Py++`_ will generate code very similar to the next one: +`Py++`_ will generate code very similar to the the following one: .. code-block:: C++ Modified: pyplusplus_dev/docs/documentation/properties.rest =================================================================== --- pyplusplus_dev/docs/documentation/properties.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/properties.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -61,7 +61,7 @@ Call policies ------------- -Consider next use case: +Consider the following use case: .. code-block:: C++ @@ -144,7 +144,7 @@ accessors, which constructs the property. `Py++`_ does it by analyzing name and type of the accessors. -`Py++`_ understands next coding conventions: +`Py++`_ understands the following coding conventions: * lowercase_with_underscores * UpperCamel Modified: pyplusplus_dev/docs/documentation/split_module.rest =================================================================== --- pyplusplus_dev/docs/documentation/split_module.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/split_module.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -50,7 +50,7 @@ as follows: * every class has it's own source & header file -* next declarations are split to separate source files: +* the following declarations are split to separate source files: * named & unnamed enumerations @@ -102,10 +102,10 @@ This mode solves the problem, I mentioned earlier - you have to expose huge class and you have problems to compile generated code. -`Py++`_ will split huge class to files using next strategy: +`Py++`_ will split huge class to files using the following strategy: * every generated source file can contain maximum 20 exposed declarations -* next declarations are split to separate source files: +* the following declarations are split to separate source files: * enumerations Modified: pyplusplus_dev/docs/documentation/warnings.rest =================================================================== --- pyplusplus_dev/docs/documentation/warnings.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/documentation/warnings.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -159,7 +159,7 @@ The `Py++`_ package defines all loggers in the ``pyplusplus._logging_`` package. Both packages define a ``loggers`` class. Those classes keep references to - different loggers. The ``loggers`` classes look very similar to the next class: + different loggers. The ``loggers`` classes look very similar to the following class: .. code-block:: Python Modified: pyplusplus_dev/docs/download.rest =================================================================== --- pyplusplus_dev/docs/download.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/download.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -32,7 +32,7 @@ ------------ In command prompt or shell change current directory to be "pyplusplus-X.Y.Z". -"X.Y.Z" is version of `Py++`_. Type next command: +"X.Y.Z" is version of `Py++`_. Type the following command: | ``python setup.py install`` Modified: pyplusplus_dev/docs/examples/boost/boost.rest =================================================================== --- pyplusplus_dev/docs/examples/boost/boost.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/examples/boost/boost.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -37,7 +37,7 @@ I believe that `Py++`_ is ready for hard work. It is quick, stable and flexible. `Py++`_ is a new tool and in my opinion I should prove its -usefulness. Using `Py++`_, I exposed next libraries to Python: +usefulness. Using `Py++`_, I exposed the following libraries to Python: * `Boost.Date_Time`_ * `Boost.CRC`_ Modified: pyplusplus_dev/docs/history/history.rest =================================================================== --- pyplusplus_dev/docs/history/history.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/history/history.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -61,7 +61,7 @@ **Keep reading.** If you use "function transformation" functionality, than it is possible the - generated code will **NOT** work. Consider next example: + generated code will **NOT** work. Consider the following example: .. code-block:: C++ @@ -466,7 +466,7 @@ Sorry for the inconvenience :-(. -3. Better split of extension module to files. From now next declarations will +3. Better split of extension module to files. From now the following declarations will have dedicated file: * named enumerations, defined within namespace Modified: pyplusplus_dev/docs/peps/dsl_challenge.rest =================================================================== --- pyplusplus_dev/docs/peps/dsl_challenge.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/peps/dsl_challenge.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -14,7 +14,7 @@ Py++ user interface ------------------- -I will use next C++ code as an example: +I will use the following C++ code as an example: .. code-block:: C++ @@ -39,7 +39,7 @@ 3. to rename ``x`` and ``y`` to ``X`` and ``Y`` -Today, in order to configure this class, the user has to write next code: +Today, in order to configure this class, the user has to write the following code: .. code-block:: Python @@ -117,7 +117,7 @@ PointTmpl = mb.module.template('Point') Point = PointTmpl( 'int' ) - This is a trivial example, which is why it looks grate. Consider next class: + This is a trivial example, which is why it looks grate. Consider the following class: .. code-block:: C++ @@ -163,7 +163,7 @@ --------- Using B-API the user is forced to write full declaration name, otherwise he faces -next problem: +the following problem: .. code-block:: Python Modified: pyplusplus_dev/docs/pyplusplus.rest =================================================================== --- pyplusplus_dev/docs/pyplusplus.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/pyplusplus.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -23,7 +23,7 @@ `Boost.Python`_ library allows you to expose C++ code to `Python`_ in quick and elegant way. Code generation process, using Py++ consists from few steps. -Next paragraphs will tell you more about every step. +The following paragraphs will tell you more about every step. *"read declarations"* Modified: pyplusplus_dev/docs/quotes.rest =================================================================== --- pyplusplus_dev/docs/quotes.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/quotes.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -134,7 +134,7 @@ .. _`pythonOCC` : http://www.minerva-plm.org/pythonOCC/ .. _`OpenCascade` : http://www.opencascade.org/ -* I am :-). I created Python bindings for next libraries: +* I am :-). I created Python bindings for the following libraries: * `Boost.Date_Time`_ * `Boost.CRC`_ Modified: pyplusplus_dev/docs/troubleshooting_guide/easy_extending_guide/easy_extending_guide.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/easy_extending_guide/easy_extending_guide.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/troubleshooting_guide/easy_extending_guide/easy_extending_guide.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -36,7 +36,7 @@ Boost.Python doesn't handle ``C arrays``, the only exception are ``char*`` and ``wchar_t*``. -Consider next function: +Consider the following function: .. code-block:: C++ Modified: pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest 2008-08-13 19:45:24 UTC (rev 1392) +++ pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest 2008-08-14 07:31:30 UTC (rev 1393) @@ -32,7 +32,7 @@ add a missing functionality to Boost.Python library. Well, I quickly found out that the task is not a trivial one. -The next solution, I thought about, was to expose the exception class as-is and +The following solution, I thought about, was to expose the exception class as-is and to define new class in Python, which derives from it and the built-in ``Exception``. I implemented it and when I run the code I've got ``TypeError``: "Error when calling the metaclass bases multiple bases have instance lay-out conflict". This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |