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

BUG: doc/tests is 10 years old (as of 2020) #74

Open
pcmoore opened this issue May 26, 2020 · 3 comments
Open

BUG: doc/tests is 10 years old (as of 2020) #74

pcmoore opened this issue May 26, 2020 · 3 comments

Comments

@pcmoore
Copy link
Member

pcmoore commented May 26, 2020

Considering the number of commits since then it is safe to say that doc/tests is outdated. Either this area needs to be updated (and likely converted to something other than SGML) or it should be removed.

@pcmoore pcmoore changed the title BUG: doc/tests is 10 years old BUG: doc/tests is 10 years old (as of 2020) May 26, 2020
@WOnder93
Copy link
Member

WOnder93 commented Jul 9, 2020

I'm in favor of removing it. I don't think it would be worth the effort to maintain the documentation, since the way it is written now it seems to be bound closely with the implementation, which means it would both require frequent updates and largely duplicate what can be read from the code directly.

@stephensmalley
Copy link
Member

That's fine. Might want to skim through quickly and see if anything from it ought to be copied to the README or added as an open issue. The most important part of it originally was the coverage tables to show what was being tested but that's long since obsolete and I believe we have created GH issues for known gaps in the current testsuite.

@pcmoore
Copy link
Member Author

pcmoore commented Jul 9, 2020

Works for me. I would second @stephensmalley's comment about making sure everything relevant is captured before removing the file.

Of course the nice thing about revision control is that even if we remove the file, it is never really "gone" if we decide we need some information from it.

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

3 participants