We aren't using Documentation issue reports to report problems with Community Documentation pages any more. I added a link to this issue as a comment on the page. Please feel free to edit the page!
We have reversed the earlier policy, and instead of using issues to report problems in the Community Documentation, we are reporting issues with the page content by using comments and page status.
What exactly is unusable about the documentation on api.drupal.org -- can you be more specific? If it's the hierarchy, that is going to get pared down considerably shortly. If the doc is bad, let's file an issue in Drupal Core to get it fixed. Just saying "it's unusable" is not very illuminating.
Well put yourself in the position of someone wanting, say, to test whether a regex pattern is on a page, or whether a variable has a particular value. How do you go about finding the right method by reading that page?
Well first of all you would need to be on DrupalWebTestCase, not DrupalUnitTestCase, if you want to look at text on a web page. But again, if you think the docs there are unusable and don't give you the one-line descriptions that illuminate what the assertions are testing, let's fix up the docs.
If this is still an issue, it needs to be in the core docs issue queue -- that would be if you have specific suggestions for how to improve the documentation of the test assertion classes/methods.
Or else it needs to be in the API module issue queue, if you have specific suggestions for how to fix the API module so that class methods would be easier to locate on the site (that would be the place for any automatically-generated documentation). There have been considerable improvements since this issue was filed, and maybe they've taken care of your concerns, and there is also an effort underway to have Solr full-text search on api.drupal.org.
So... I'm closing this as "won't fix" for now; feel free to reopen and move to an appropriate queue if you have specific suggestions.
Comments
Comment #1
jhodgdonWe aren't using Documentation issue reports to report problems with Community Documentation pages any more. I added a link to this issue as a comment on the page. Please feel free to edit the page!
Comment #2
joachim commentedSo where do problems with documentation get reported?
Comment #3
jhodgdonWe have reversed the earlier policy, and instead of using issues to report problems in the Community Documentation, we are reporting issues with the page content by using comments and page status.
For more details, see:
http://drupal.org/node/14345
http://drupal.org/node/24565
http://drupal.org/node/1204344
and the text at the top of http://drupal.org/node/add/project-issue/documentation
Comment #4
joachim commentedI'm reopening and retitling this:
- editing that page by hand and adding all the assertions is a gargantuan task
- the docs here are unusable: http://api.drupal.org/api/drupal/modules!simpletest!drupal_web_test_case...
Comment #5
jhodgdonWhat exactly is unusable about the documentation on api.drupal.org -- can you be more specific? If it's the hierarchy, that is going to get pared down considerably shortly. If the doc is bad, let's file an issue in Drupal Core to get it fixed. Just saying "it's unusable" is not very illuminating.
Comment #6
joachim commentedWell put yourself in the position of someone wanting, say, to test whether a regex pattern is on a page, or whether a variable has a particular value. How do you go about finding the right method by reading that page?
Comment #7
jhodgdonWell first of all you would need to be on DrupalWebTestCase, not DrupalUnitTestCase, if you want to look at text on a web page. But again, if you think the docs there are unusable and don't give you the one-line descriptions that illuminate what the assertions are testing, let's fix up the docs.
Comment #8
jhodgdonIf this is still an issue, it needs to be in the core docs issue queue -- that would be if you have specific suggestions for how to improve the documentation of the test assertion classes/methods.
Or else it needs to be in the API module issue queue, if you have specific suggestions for how to fix the API module so that class methods would be easier to locate on the site (that would be the place for any automatically-generated documentation). There have been considerable improvements since this issue was filed, and maybe they've taken care of your concerns, and there is also an effort underway to have Solr full-text search on api.drupal.org.
So... I'm closing this as "won't fix" for now; feel free to reopen and move to an appropriate queue if you have specific suggestions.