[DOC] in docstring, rename Example to Examples sections
#7341
Conversation
This file contains 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
fkiraly
requested review from
achieveordie,
benHeid,
fnhirwa,
geetu040,
pranavvp16,
XinyuWuu and
yarnabrina
as code owners
yarnabrina
previously approved these changes
Oct 27, 2024
There was a problem hiding this comment.
Approved, but I want to note that few of these classes are missing from hosted docs, at least based on searching class names in search area of this PR docs page.
If it's intentional, please ignore. But missing ones include Vecm, probability distributions, etc.
|
I see - |
|
Yes, same issue has propagated in |
yarnabrina
approved these changes
Oct 28, 2024
fkiraly
added a commit
to sktime/skpro
that referenced
this pull request
Nov 3, 2024
It seems that examples in a docstring section with title `Example` are not displayed by sphinx, the name needs to be `Examples`. This PR corrects the section header in a number of docstrings. Mirror of sktime/sktime#7341 in `sktime`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It seems that examples in a docstring section with title
Exampleare not displayed by sphinx, the name needs to beExamples.This PR corrects the section header in a number of docstrings.