Skip to content

Commit

Permalink
Extend documentation and test suite.
Browse files Browse the repository at this point in the history
  • Loading branch information
baradi09 committed Mar 15, 2016
1 parent 44d73bf commit 6a9b171
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 76 deletions.
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
Fypp — Python powered Fortran metaprogramming
=============================================

Fypp is a Python powered Fortran preprocessor. It extends Fortran with
condititional compiling and template metaprogramming capabilities. Instead of
introducing its own expression syntax, it uses Python expressions in its
preprocessor directives, offering the consistency and flexibility of Python when
formulating metaprogramming tasks. It puts strong emphasis on robustness and on
neat integration into Fortran developing toolchains.
Fypp is a Python powered preprocessor. It can be used for any programming
languages but its primary aim is to offer a Fortran preprocessor, which helps to
extend Fortran with condititional compiling and template metaprogramming
capabilities. Instead of introducing its own expression syntax, it uses Python
expressions in its preprocessor directives, offering the consistency and
versatility of Python when formulating metaprogramming tasks. It puts strong
emphasis on robustness and on neat integration into developing toolchains.

The project is `hosted on bitbucket <http://bitbucket.org/aradi/fypp>`_.

Expand Down Expand Up @@ -57,7 +58,7 @@ Main features
use serial
#:endif

* Iterated output (e.g. for Fortran templates)::
* Iterated output (e.g. for generating Fortran templates)::

interface myfunc
#:for dtype in [ 'real', 'dreal', 'complex', 'dcomplex' ]
Expand Down Expand Up @@ -165,7 +166,6 @@ environment variable, by just issuing ::
fypp



Running
=======

Expand Down
10 changes: 6 additions & 4 deletions bin/fypp
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,16 @@ using following classes:
* `Processor`_: Connects `Parser`, `Builder`, `Renderer` and `Evaluator` with
each other and returns for a given input the preprocessed output.
* `Fypp`_: Command line preprocessor. Drives `Processor` according to the
command line arguments.
* `Fypp`_: Command line preprocessor. Initializes and drives
`Processor` according to the command line arguments.
If any expected error occurs during processing, `FyppError`_ is raised.
Additional to the ones above, following class is used for fine tuning:
* `LineFolder`_: Folds overlong lines by using Fortran continuation lines.
* `FortranLineFolder`_: Folds overlong lines by using Fortran continuation
lines.
'''

from __future__ import print_function
Expand Down Expand Up @@ -177,7 +179,7 @@ class Parser:
Args:
includedirs (list): List of directories, in which include files should
be searched for, when they are not found in the default location.
be searched for, when they are not found at the default location.
'''

def __init__(self, includedirs=None):
Expand Down
Loading

0 comments on commit 6a9b171

Please sign in to comment.