Add a few methods to manual & fix doctests #32417
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
|
Scratch that -- Edit: removed the |
This is not, strictly speaking, well defined. There is no official rule as to which docstring should get executed first. This will not be supported in a future version of Documenter.
Also fix the doctest in the docstring. The simpler println variant seems to be more reliable when printing from a another task (with at-show, the "Hello" string did not actually get printed).
The function is not exported. Note that it does not currently get doctested, but will be tested in a future Documenter version.
This is not currently included in the manual and therefore not doctested, but will be in the future.
Not currently doctested since it is not included in the manual, but will be in the future.
Also fix a doctest in one of the docstrings.
And fix the doctests in the docstrings.
Fix doctests in the docstrings of LinearAlgebra.isbanded, LinearAlgebra.promote_leaf_eltypes and SparseArrays.dropstored!. All the functions are unexported and not included in the manual. They are currently not being doctested, but will be with a future version of Documenter.
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.
Primarily this is fixing outdated doctests that are not being currently tested because the associated docstrings are not included in the manual. But I also discovered an unused broken function (
Distributed.head_and_tail) and a few methods that were not included in the man pages, but probably should.The commit messages have more details.
It does touch quite a few different parts of the code, so I can also separate this into different PRs if that would help the review.
These were revealed by #32376.