Part of meta-issue #1310084: [meta] API documentation cleanup sprint

CommentFileSizeAuthor
#7 xmlrpc_docs-1649140-6.patch9.03 KBalbert volkman

Comments

mjonesdinero’s picture

mjonesdinero commented
Assigned: Unassigned » mjonesdinero

will work on this.. thanks

mjonesdinero’s picture

mjonesdinero commented

@jhodgdon

it seems the file on XMLrpc are already clean, i have the updated clone of the drupal 8 on my local

or are there things need to be done their because the indention even the 80 characters limit per line is also okie

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I took a look at the files in the xmlrpc directory and its subdirectories, and found a few things that need cleaning up:

a) xmlrpc.api.php - hook_xmlrpc_alter() doc starts with wrong verb tense, see
http://drupal.org/node/1354#hooks

b) xmlrpc.server.inc - first function starts with wrong verb tense, see
http://drupal.org/node/1354#functions

c) xmlrpc.inc - several functions do not have parameter docs

d) tests subdirectory - xmlrpc_test.module has no documentation in it at all.

e) lib subdirectory - the test files in there need some work. XmlRpcBasicTest.php for instance has wrong verb tenses in its documentation headers for class and methods. See:
http://drupal.org/node/1354#classes
One note: the getInfo() and setUp() functions in tests currently are required *not* to have documentation headers, so don't add those. Long story.

mjonesdinero’s picture

mjonesdinero commented
Assigned: mjonesdinero » Unassigned
fotuzlab’s picture

fotuzlab commented
Assigned: Unassigned » fotuzlab

following up with #1650894: Make xmlrpc module pass Coder Review
assigning this to myself as both the issues are related.

albert volkman’s picture

albert volkman commented
Status: Active » Needs review
StatusFileSize
new xmlrpc_docs-1649140-6.patch9.03 KB

First pass at this.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Needs review » Closed (won't fix)

These issues are a lot of work with very little tangible payoff, so I'm closing the rest of them as "won't fix". Your efforts on working on this issue were appreciated... it was just my fault for starting a task that was very difficult to get right.

Let's instead put our effort into fixing and reviewing documentation that is really unclear and/or wrong, and I hope that the people who worked on these issues are not afraid to jump into a more reasonable issue!