-
-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs clarifying list-doc and install-doc #754
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the PR! This is definitely an improvement.
Please see the suggested changes below. These are my initial thoughts on how to make this section a little more clear; they are not perfect, but I'll bet we can collectively come up with something better.
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
@ddalcino thanks. So one thing I noticed is So if I only want the But I don't see a way to figure this out from So basically the archives that make up a module are hidden from |
You are correct. In general, there is only a single archive for each module, except for the base module and the There are a few edge cases, like this one, where a module contains 2 or more archives. The purpose of the You're welcome to document this as well if it really bothers you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wording wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed suggested wording improvements.
Co-authored-by: David Dalcino <ddalcino@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
A GitHub pro tip for @rectalogic: We are able to apply a batch of changes during code reviewing: Incorporating feedback in your pull request - GitHub Docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't test the code, but have read the docs. It looks OK to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I ran the code and it does exactly what the code-block sections say they will.
Fixes #753