Conversation
Collaborator
Author
|
@nkoukpaizan @superwhiskers Whoever can get to this first, super quick fix so the RTD can build correctly. |
nkoukpaizan
reviewed
Sep 15, 2026
| std::unique_ptr<State> scale_; | ||
| /** | ||
| * @brief The absolute value of yprev. Used to calculate \ref scale_ | ||
| * @brief The absolute value of yprev. Used to calculate `scale_` |
Collaborator
There was a problem hiding this comment.
I would expect \ref scale_ to work... CC @alexander-novo
Collaborator
Author
There was a problem hiding this comment.
RTD did not like it, I think we saw similar issue before @alexander-novo
Collaborator
There was a problem hiding this comment.
I'll take a look at this, but in general, I don't like making the Doxygen documentation worse just to support RTD.
Collaborator
Author
There was a problem hiding this comment.
I am trying to get more details on why this causes issues so we don't have to compromise
I don't use Doxygen, so that's why I was swift to correct it this way
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
3 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.
Description
Fix some Doxygen comments and links that failed on RTD.
This branch fixes those: https://gridkit.readthedocs.io/en/lukel-dev/