You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
My only concern with having writers clear the docs is using multiple formats at once. It's pretty minor since the folder would just be cleared more than once. I would also like to have a warning about AppendJsonWriter needed to be run by itself in the README after merging (I can take care of this, just want to make sure I remember).
I'm not sure AppendJsonWriter makes sense to me. I would guess you could do something very similar by writing a rake task similar to the one you list above with just the JSON format. It should only output specs in the foo_spec.rb file, no?
Without the AppendJsonWriter, the index would be blown away everytime we regenerate docs. If we want to be able to use the index, we need some way to add the references to any added scenarios. It does the same thing as the JsonWriter for all of the other files, hence it inherits from it. The only implementation difference is in how the index is built.
@oestrich we have fairly extensive documentation specs written and takes a substantial amount of time to run the entire suite. This allows us to target specific files that have changed, enabling us to scale with this tool.
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.
Example of use
in lib/tasks/my_docs.rspec:
in spec/support/documentation.rb
then when I run
rake mydocs:generate[spec/acceptance/foo_spec.rb]
, I only generate output relevant to foo.