add info to docs

2021-04-26 12:15:03 -04:00
parent 2c6fe2d0b5
commit 0eee2d013d
1 changed files with 11 additions and 0 deletions
--- a/src/text_file_reader.cpp
+++ b/src/text_file_reader.cpp
@ -54,6 +54,17 @@ TextFileReader::TextFileReader(const std::string &filename, const std::string &f
 /**
 * \overload
 *
+\verbatim embed:rst
+
+This function is useful in combination with :cpp:func:`utils::open_potential`.
+
+.. note::
+
+   The FILE pointer is not closed in the destructor, but will be advanced
+   when reading from it.
+
+\endverbatim
+ *
 * \param  fp        File descriptor of the already opened file
 * \param  filetype  Description of file type for error messages */