intro plt() alias discussion #262
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
|
You make a good point. But, in that case, should we just go all the way and move the tooltip to the very top of the document? (I.e. Just after the main heading.) |
|
Well I think the main function should be presented before its alias. Otherwise we can't even answer: "alias to what?" But anywhere after the first evaluated |
|
Circling back to this with a few tweaks. If you're happy with my suggestion, please feel free to merge. (Or let me know and I will.) |
|
LGTM |
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.
The
plt()tooltip is great and highly visible.I moved it to just after we call
tinyplot()for the first time, so users see it immediately.I removed the section on
plt(). IMHO, the tooltip is already very visible, and spending a full section on an alias at the top of the intro vignette is overkill. The start of the introduction in prime real estate in a tutorial, and we should invest it on "real" features.