Closed AddisonSchiller closed 7 years ago
Agreed, since we'll be adding a bunch of these, it would be good to have a way to autogen it.
...or....
What if we keep this as a static file, but add something to test/
to make sure everything in the setup.py is mentioned in the doc file? Then updating to the list becomes a prerequisite of submitting a PR. Otherwise travis will fail and yell at the submitter. Would that be easier?
Opinions? @cslzchen, @AddisonSchiller?
I like the second idea. It is visible to both test
and CR. (I have no clue how to do it through autogen ...)
I could do it either way. I like the idea of travis yelling at people (probably mostly me).
For autogen, where could we set it up so it runs often enough? Or would it be a script to run before you make a PR that adds/removes new file types?
Let's skip autogen and just add a validation test. That also gives us more control over the formatting and we don't have to worry about forgetting to run it. Please add that to this PR, then it LGTM. The test can dogfood its own PR.
Sweet! Merging.
refs: https://openscience.atlassian.net/browse/SVCS-525
Purpose
Add a public human readable list of file types supported by mfr Add tests for this documentation
Summary of changes
Added a new file in the top level directory with a list of supported file types Added tests to make sure it gets updated.
QA/Testing
Documentation change, none needed.