Improve and repair some docs#142
Merged
steve-downey merged 2 commits intobemanproject:mainfrom Sep 22, 2025
Merged
Conversation
Wrong docs were applied to `emplace`, and added details to other functions.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
include/beman/optional/optional.hpp
Outdated
| * @brief Nullopt assignment operator. | ||
| * | ||
| * @return optional& | ||
| * |
There was a problem hiding this comment.
[pre-commit] reported by reviewdog 🐶
Suggested change
| * | |
| * |
include/beman/optional/optional.hpp
Outdated
| * @tparam F | ||
| * @param f | ||
| * @return auto | ||
| * |
There was a problem hiding this comment.
[pre-commit] reported by reviewdog 🐶
Suggested change
| * | |
| * |
include/beman/optional/optional.hpp
Outdated
| * | ||
| * @details | ||
| * The return type is the same as \tcode{std::invoke_result_t<F, T&>}, | ||
| * but wrapped in an optional. The function \p f must return an optional type. |
There was a problem hiding this comment.
[pre-commit] reported by reviewdog 🐶
Suggested change
| * but wrapped in an optional. The function \p f must return an optional type. | |
| * but wrapped in an optional. The function \p f must return an optional type. |
include/beman/optional/optional.hpp
Outdated
| * @tparam F | ||
| * @param f | ||
| * @return optional<std::invoke_result_t<F, T&>> | ||
| * |
There was a problem hiding this comment.
[pre-commit] reported by reviewdog 🐶
Suggested change
| * | |
| * |
include/beman/optional/optional.hpp
Outdated
| * @return optional | ||
| * @details | ||
| * The return type is the same as the return type of \p f, which must | ||
| * return an optional type. |
There was a problem hiding this comment.
[pre-commit] reported by reviewdog 🐶
Suggested change
| * return an optional type. | |
| * return an optional type. |
Pull Request Test Coverage Report for Build 17786715427Details
💛 - Coveralls |
Fix whitespace issues.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Wrong docs were applied to
emplace, and added details to other functions.