Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a summarization and indexing tool? #15

Open
JamesPHoughton opened this issue Sep 2, 2015 · 1 comment
Open

Add a summarization and indexing tool? #15

JamesPHoughton opened this issue Sep 2, 2015 · 1 comment

Comments

@JamesPHoughton
Copy link
Contributor

Somewhere down the line, it would be neat to have an index and a summary of the tests.

The indexer could detect functions that show up in any file in the test or sample set, and give links to them. This would be helpful in knowing if a specific piece of functionality is in the test suite, or if it still needs to be added.

The summarization tool could summarize the contents of each test or sample directory, perhaps based on the readme files. It could highlight cases where there are outstanding 'todo' items, or where there are model representations or screenshots missing.

@bpowers
Copy link
Contributor

bpowers commented Sep 3, 2015

Yea, something like this makes sense. I left the screenshot out of some of the models I did because there was just 1 or 2 auxiliaries, and it didn't seem worth the hassle, but I like how you've added a text-box with some description in yours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants