Closed FloatingSunfish closed 3 years ago
Thanks! I've pushed changes to address these.
Thanks for adding these to the docs, @abingham!
I've reviewed the changes and they all look good.
However, I would like to propose the following change in the init
section from:
Similarly, you need to create a new session with init whenever your code-under-test changes.
To: Similarly, you need to create a new session with init whenever your code-under-test or test codes change.
Your thoughts?
That's a good point. I've updated the docs and pushed the change.
I would like to propose the following Documentation changes to help make Cosmic Ray easier to use for users:
Init
SectionYou should always run
init
whenever you make any production code and test changes.You should always run
init
whenever you make changes to your configuration file. Fields that do not requireinit
to be rerun should also be added to the documentation.Installation Section
cr-filter-operators
SectionPlease state that regular expressions are optional, and provide examples for excluding operators both with and without regular expressions.
For the examples that include regular expressions, please provide a brief overview of how the regular expression is affecting the configuration.
Miscellaneous