fix(gen-docs): fix issue where docs are generated wrong#310
Merged
ariporad merged 1 commit intoshelljs:masterfrom Jan 26, 2016
nfischer:fix-gen-docs
Merged
fix(gen-docs): fix issue where docs are generated wrong#310ariporad merged 1 commit intoshelljs:masterfrom nfischer:fix-gen-docs
ariporad merged 1 commit intoshelljs:masterfrom
nfischer:fix-gen-docs
Conversation
This fixes an issue where the gen-docs script's sed() command would improperly update the docs. Travis now checks that docs are generated properly.
Member
Author
|
@ariporad could you take a look at this when you get the chance? |
Member
Author
|
Also, we could consider switching to only one |
Contributor
|
LGTM |
ariporad
added a commit
that referenced
this pull request
Jan 26, 2016
fix(gen-docs): fix issue where docs are generated wrong
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This fixes an issue (#309) where the gen-docs script's sed() command would improperly
update the docs.
As a bonus, Travis now checks that docs are generated properly (or, more specifically, that no files have been changed by running the tests and re-generating docs, which is exactly what we want). This prevents breaking changes in
sed()from going unnoticed. This will also prevent people from modifying doc-comments in the source files without generating docs, or by modifying the README manually without changing comments.