Skip to content

Commit 12fb261

Browse files
committed
Fix docs
1 parent 5074f3d commit 12fb261

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,11 @@ x=gf.fFort(SHARED_LIB_NAME,MOD_FILE_NAME)
7777

7878
``x`` now contains all variables, parameters and procedures from the module (tab completable).
7979

80+
> **_NOTE:_** The mod data is cached to speed up re-reading the data. To control this pass cache_folder to fFort.
81+
A value of False disables caching, a string sets the folder location, while leaving the argument as None defaults to appdirs ``user_cache_dir``.
82+
83+
84+
8085
### Functions
8186
````python
8287
y = x.func_name(a,b,c)

tests/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How many tests do we actually?
22

3-
The main difficulty in writing gfort2py is handling ths head number of combinations of options that are available in Fortran code.
3+
The main difficulty in writing gfort2py is handling the huge number of combinations of options that are available in Fortran.
44
If we consider a simple integer: How many different ways can we declare an integer?
55

66
First we must consider where the integer is declared:
@@ -24,7 +24,8 @@ Is it an array? If so:
2424
- Explicit but runtime sized (dimension(n) where n is another integer)
2525
- Assumed size (dimension(*))
2626
- Assumed shape (dimension(:))
27-
- Allocatable
27+
- allocatable
28+
- pointer/target
2829

2930
Then of course there are the combinations of the previous options. As well, for arrays its helpful to test multiple dimensions to ensure the
3031
ordering is correct.
@@ -154,7 +155,7 @@ test similar things should have similar names, i.e all thing testing explicit ar
154155

155156
# Skipping tests
156157

157-
For things that don't work yet you can use the python decorator ``@pytest.mark.skip`` to skip the test. NOthing needs to be done on the Fortran side for tests that don't work yet.
158+
For things that don't work yet you can use the python decorator ``@pytest.mark.skip`` to skip the test. Nothing needs to be done on the Fortran side for tests that don't work yet.
158159

159160
# Bug reports
160161

0 commit comments

Comments
 (0)