(maint) Document 0.13 Release #402
Merged
Conversation
This file contains hidden or 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
jpogran
force-pushed
the
maint-document-0.13-release
branch
from
c5ab071 to
47de157
Compare
michaeltlombardi
suggested changes
Oct 17, 2018
README.md
Outdated
|
|
||
| ### Outline View | ||
|
|
||
| The new `Outline View` shows the symbol tree of the currently selected Puppet manifest. This currently supports classes, types, variables and parameters. More symbols are planned to be added. |
There was a problem hiding this comment.
Pseudo nit: One sentence per line (semantic linefeeds). This makes review (and editing different) much easier.
The last sentence should be reworked - maybe something like a check box list with the possible symbols and only those which are implemented are checked? Or a link to the issue? Or drop the sentence entirely and just update the section when new symbols are added?,
There was a problem hiding this comment.
While I generally agree on linefeeds, the whole document does not follow that proscription. I'm disinclined to acquiesce to your request here, and instead volunteer you to copy-edit the readme :)
Will work on last sentence
There was a problem hiding this comment.
Suggested change
| The new `Outline View` shows the symbol tree of the currently selected Puppet manifest. This currently supports classes, types, variables and parameters. More symbols are planned to be added. | |
| The new `Outline View` shows the symbol tree of the currently selected Puppet manifest. | |
| This currently supports classes, types, variables and parameters. |
michaeltlombardi
approved these changes
Oct 17, 2018
This commit is a documentation update for the 0.13 release. It adds missing issues to the Changelog, and adds the new features to the README. The new features are documented with text descriptions as well as animated gifs.
jpogran
force-pushed
the
maint-document-0.13-release
branch
from
5067016 to
a848ac8
Compare
jpogran
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Should document: