Skip to content
This repository has been archived by the owner on Jun 4, 2019. It is now read-only.

Allow sorting between no docs and docs #21

Open
thenickcox opened this issue Apr 1, 2015 · 4 comments · May be fixed by #24
Open

Allow sorting between no docs and docs #21

thenickcox opened this issue Apr 1, 2015 · 4 comments · May be fixed by #24

Comments

@thenickcox
Copy link
Contributor

I was just paging through the docs for rails, and it took me an embarrassingly long time before I realized that the docs there were for every method, not just the undocumented ones. And yes, I saw the
"(undocumented)" string next to the method title, but I was confused.

My use case was coming to manually find undocumented methods, because the one I received via email today stumped me. A way to filter between documented and undocumented methods would be awesome.
@prathamesh-sonpatki
Copy link
Member

@thenickcox What do you mean by "(undocumented)" string next to the method title? Please show an example.

@thenickcox
Copy link
Contributor Author

Sorry that wasn't clear.
screen shot 2015-03-31 at 11 09 15 pm

@thenickcox
Copy link
Contributor Author

@prathamesh-sonpatki Went to write a test for this, but I didn't want to introduce any new testing strategies. I thought about just wrapping it into a controller test and checking for a sorted param, using either the missing_docs or with_docs scopes on DocMethod. But I couldn't think of a way to do test these scopes without creating records and testing their inclusion or exclusion. But this would have to hit the database. Is that something you'd really like to avoid?

@schneems
Copy link
Member

schneems commented Apr 2, 2015

But this would have to hit the database. Is that something you'd really like to avoid?

I prefer integration style tests. That being said apparently I've neglected writing any for this project 0_o

Hitting the DB is fine. You can see how we use fixtures in https://github.com/codetriage/codetriage/tree/master/test/fixtures

thenickcox added a commit to thenickcox/docs_doctor that referenced this issue Apr 3, 2015
@thenickcox
Add sorting of doc_methods on a repo by documentation status
5f815e4 
This commit adds sorting on a repo between documented and undocumented
methods, via a simple UI.

Closes codetriage#21.
@thenickcox thenickcox linked a pull request Apr 3, 2015 that will close this issue
Open
thenickcox added a commit to thenickcox/docs_doctor that referenced this issue Apr 3, 2015
@thenickcox
Add sorting of doc_methods on a repo by documentation status
ec281f8 
This commit adds sorting on a repo between documented and undocumented
methods, via a simple UI.

Closes codetriage#21.
thenickcox added a commit to thenickcox/docs_doctor that referenced this issue Apr 7, 2015
@thenickcox
Add sorting of doc_methods on a repo by documentation status
ef99631 
This commit adds sorting on a repo between documented and undocumented
methods, via a simple UI.

Closes codetriage#21.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add sorting of doc_methods on a repo by documentation status thenickcox/docs_doctor
3 participants
@schneems @prathamesh-sonpatki @thenickcox