Skip to content

Commit 8dd2e00

Browse files
committed
Minor doc update.
1 parent c17822e commit 8dd2e00

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/source/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This class is used to create objects that will check/update strings in files:
1515
.. autoclass:: verace.VerChecker
1616
:members:
1717

18+
1819
Custom Check Functions
1920
----------------------
2021
A function can be provided to ``VerChecker.include()``. If no explicit function is provide, the following function will be used:
@@ -24,3 +25,7 @@ A function can be provided to ``VerChecker.include()``. If no explicit function
2425
Custom functions can be defined to find strings. The first argument must be the file path and the function must return either a single ``VerInfo`` object or a list of ``VerInfo`` objects:
2526

2627
.. autodata:: verace.VerInfo
28+
29+
Use this convenience function to iterate through the lines in a given file:
30+
31+
.. autofunction:: verace.readlines

0 commit comments

Comments
 (0)