DOC: update OptimizeResult notes #14693
Merged
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
Closes: scipy#14683 Does two things: - Address the problem of `Notes` being placed before `Attributes` - Edit the spelling in the first sentence.
mdhaber
reviewed
Sep 4, 2021
[skip azp] [skip actions]
FirefoxMetzger
commented
Sep 4, 2021
There was a problem hiding this comment.
@mdhaber It's sphinx, so we will have to use rst instead of markdown here I believe.
Edit: ... or not? This is a bit surprising, but also pretty cool. I'll have to take a closer look at what scipy does to render API docs.
|
It seems to be rendering as I intended. Look good to you? |
|
@mdhaber Yes. Looks perfect to me; sorry for the noise. I was under the impression that rst and markdown behave differently here. Clearly, I am wrong and there is some feature/behavior that I am not aware of :) |
|
Thanks @FirefoxMetzger! |
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.
Closes: #14683
Does two things:
Notesbeing placed beforeAttributes