[MAINT] test build all test docs in strict mode#340
Open
Remi-Gau wants to merge 5 commits intosphinx-contrib:masterfrom
Open
[MAINT] test build all test docs in strict mode#340Remi-Gau wants to merge 5 commits intosphinx-contrib:masterfrom
Remi-Gau wants to merge 5 commits intosphinx-contrib:masterfrom
Conversation
Remi-Gau
commented
Jan 11, 2026
| classdef Domain | ||
| % Describes a set of elements with a common structure | ||
| % | ||
| % Those elements can be compared (`.eqv`), and random elements can be produced (`.sample`). |
Collaborator
Author
There was a problem hiding this comment.
this needs to be removed to avoid a warning about a missing ref
Remi-Gau
commented
Jan 11, 2026
| % BaseClass Methods: | ||
| % BaseClass - the constructor, whose description extends | ||
| % to the next line | ||
| % |
Collaborator
Author
There was a problem hiding this comment.
fixes a doc build warning
Remi-Gau
commented
Jan 11, 2026
| "BaseClass Methods:\n" | ||
| "* :meth:`BaseClass() <BaseClass.BaseClass>` - the constructor, whose description extends\n" | ||
| " to the next line\n\n" | ||
| "DoBase - another BaseClass method\n" |
Collaborator
Author
There was a problem hiding this comment.
needed to change this test after modifying BaseClass (see https://github.com/sphinx-contrib/matlabdomain/pull/340/files#r2680058113)
but I am a bit surprised that just adding an extra line changes:
"* :meth:`DoBase() <BaseClass.DoBase>` - another BaseClass method\n"
to
"DoBase - another BaseClass method\n"
Remi-Gau
commented
Jan 11, 2026
| "BaseClass Methods:\n" | ||
| "* :meth:`BaseClass() <BaseClass.BaseClass>` - the constructor, whose description extends\n" | ||
| " to the next line\n\n" | ||
| "DoBase - another BaseClass method\n" |
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
1 participant
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.
Ideally we want to avoid build warnings in our test doc