From 1c14b786d0a55ae292bec1df60f3fa2bd7d6a82f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A5rd=20Skaflestad?= Date: Tue, 20 Dec 2022 15:58:57 +0100 Subject: [PATCH] Fix Copy-Pasted Function Documentation The enumerated 'segments()' overload takes a well number, not a well name. Pointy Hat: [at]bska --- opm/input/eclipse/Schedule/MSW/SegmentMatcher.hpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/opm/input/eclipse/Schedule/MSW/SegmentMatcher.hpp b/opm/input/eclipse/Schedule/MSW/SegmentMatcher.hpp index 4d1fe8f0b..ecaef6b73 100644 --- a/opm/input/eclipse/Schedule/MSW/SegmentMatcher.hpp +++ b/opm/input/eclipse/Schedule/MSW/SegmentMatcher.hpp @@ -166,12 +166,12 @@ public: /// Retrive result set's segments for single MS well. /// - /// \param[in] well Named MS well. Should usually be one of the - /// items in the return value from \code wells() \endcode. + /// \param[in] well Well number. Should be between zero and \code + /// numWells() - 1 \endcode inclusive. /// /// \return range of \c well's segments matching the input request. - /// Empty unless \p well is one of the return values from \code - /// wells() \endcode. + /// Empty unless \p well is between zero and \code numWells() - 1 + /// \endcode inclusive. WellSegmentRange segments(const std::size_t well) const; friend class SegmentMatcher;