Remove two cross-references #17969
Merged
Remove two cross-references #17969
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
* Replace a malformed link in `write` docstring with a literal `write` rather than
a real cross-reference, since that would just cross-reference itself. Also move
`write` docstring inline.
* Remove cross-reference for `<<` from inside a literal since text inside a literal
can't contain a link. A cross-reference to `<<` already appears at the end of the
docstring.
| @@ -230,7 +230,7 @@ end | |||
|
|
|||
| Unsigned right bit shift operator, `x >>> n`. For `n >= 0`, the result is `x` | |||
| shifted right by `n` bits, where `n >= 0`, filling with `0`s. For `n < 0`, this | |||
| is equivalent to `x [<<](:func:`<<`) -n`]. | |||
| is equivalent to `x << -n`. | |||
There was a problem hiding this comment.
noticed this on the mailing list, thought it looked odd
There was a problem hiding this comment.
It does, though the idea behind it, adding links in bits of code, would be great to have at some point. Allowing Documenter to automatically add links inside literals and code blocks should probably be possible I think, though would need a bit of work.
|
Travis OSX failure is unrelated, will merge shortly. |
tkelman
pushed a commit
that referenced
this pull request
Aug 20, 2016
* Replace a malformed link in `write` docstring with a literal `write` rather than
a real cross-reference, since that would just cross-reference itself. Also move
`write` docstring inline.
* Remove cross-reference for `<<` from inside a literal since text inside a literal
can't contain a link. A cross-reference to `<<` already appears at the end of the
docstring.
(cherry picked from commit 2301c27)
ref #17969
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.
writedocstring with a literalwriterather than a real cross-reference, since that would just cross-reference itself. Also movewritedocstring inline.<<from inside a literal since text inside a literal can't contain a link. A cross-reference to<<already appears at the end of the docstring.