diff --git a/doc/src/Developer_notes.rst b/doc/src/Developer_notes.rst index cd3c51fed6..e58dec94ac 100644 --- a/doc/src/Developer_notes.rst +++ b/doc/src/Developer_notes.rst @@ -25,18 +25,17 @@ following benefits: - transparent support for translating unsupported UTF-8 characters to their ASCII equivalents (the text-to-value conversion functions **only** accept ASCII characters) -In most cases (e.g. potential files) the same data is needed on all -MPI ranks. Then it is best to do the reading and parsing only on MPI -rank 0, and communicate the data later with one or more -``MPI_Bcast()`` calls. For reading generic text and potential -parameter files the custom classes :cpp:class:`TextFileReader -` and :cpp:class:`PotentialFileReader -` are available. They allow reading -the file as individual lines for which they can return a tokenizer -class (see below) for parsing the line. Or they can return blocks of -numbers as a vector directly. The documentation on `File reader -classes `_ contains an example for a typical -case. +In most cases (e.g. potential files) the same data is needed on all MPI +ranks. Then it is best to do the reading and parsing only on MPI rank +0, and communicate the data later with one or more ``MPI_Bcast()`` +calls. For reading generic text and potential parameter files the +custom classes :cpp:class:`TextFileReader ` +and :cpp:class:`PotentialFileReader ` +are available. They allow reading the file as individual lines for which +they can return a tokenizer class (see below) for parsing the line. Or +they can return blocks of numbers as a vector directly. The +documentation on :ref:`File reader classes ` +contains an example for a typical case. When reading per-atom data, the data on each line of the file usually needs to include an atom ID so it can be associated with a particular diff --git a/doc/src/Developer_utils.rst b/doc/src/Developer_utils.rst index a9df85c899..720eececcc 100644 --- a/doc/src/Developer_utils.rst +++ b/doc/src/Developer_utils.rst @@ -396,7 +396,7 @@ A typical code segment would look like this: ---------- -.. file-reader-classes: +.. _file-reader-classes: File reader classes -------------------