Documents CompScript's API #53
Conversation
timreyn
left a comment
timreyn
left a comment
There was a problem hiding this comment.
This is great, thank you!
gen_docs_api.js
Outdated
|
|
||
| // FIXME: reorder categories into a more structured order? | ||
| // eg: wcif, events, groups, persons, cluster, ...? | ||
| const categories = [ |
There was a problem hiding this comment.
One possibility would be to share this list with the list in 'functions'. But that goes against your comment above, and 'display' which is not that useful to document. What do you think?
There was a problem hiding this comment.
I think I found a way to make it work by creating a dedicated categories array and filtering out based on the name.
It's also helpful for the other documentation point you made!
gen_docs_api.js
Outdated
| - WCIF changes: **${mutations && mutations.length > 0 ? `${mutations.join(', ')}` : 'none'}**` | ||
|
|
||
| const documentation = categories.map(c => { | ||
| const functions = require(`./functions/${c}.js`).functions |
There was a problem hiding this comment.
One other thing that could be useful is a file-level 'description' that goes right under the header, explaining what is in that file. The default could be "TODO" just like the function documentation. What do you think?
There was a problem hiding this comment.
Agreed, I've taken a shot at this in the latest diff :)
| } | ||
| } | ||
| cleanupExtensions(competition) | ||
| cleanupExtensions(ctx.competition) |
There was a problem hiding this comment.
I've thrown this fix in that I totally missed in the earlier diff, sorry about that!
2 participants
I found myself often going back and forth between the builtin
HelpandListFunctions, and I figured it would be easier to just have an API reference somewhere.It's based on top of #52 so you may again want to look at the last two commits individually; the documentation can be viewed rendered by github's markdown engine here.