Multiline API documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api, documentation
Research direction
The issue names no source files or tests. Start by reviewing the current ACT IDL syntax for method descriptions, then determine how multiline element-form documentation should be represented and verify that the chosen form is accepted and preserves the full content.
Written by the indexing model from the issue text.
Description
Documentation for elements in ACT IDL is currently specified like so:
<method name="Frobricate"
description="An extremely useful method"/>
Having the description as an attribute makes perfect sense, but when writing an IDL file it makes it very hard to provide comprehensive documentation.
It would be nice, for example, to be able to provide documentation in element form also:
<method name="Frobricate"
...>
<description>
An extremely useful method.
This is an implementation of Fred Frobricator's notion of _Frobrication_, introduced in
the 1867 paper 'On Frobrication', of which you can find a copy here:
https://www.en.wikipedia.org/wiki/Frobrication
</description>
</method>
(Also happy with any other solution that allows for documentation in a similar for to my example, be it a different syntax for specifying an attribute of which I am unaware, special comments, or whatever.)
- Dominant language
- Go
- Stars
- 54
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Autodesk/AutomaticComponentToolkit
-
Autodesk/AutomaticComponentToolkit#226 · 5 comments · 3 reactions · 3 assignees ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Autodesk/AutomaticComponentToolkit#213 · 1 comment · 2 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Autodesk/AutomaticComponentToolkit#188 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
Autodesk/AutomaticComponentToolkit#183 · 1 comment ·
-
Autodesk/AutomaticComponentToolkit#162 · 1 reaction · 2 assignees ·
All issues in Autodesk/AutomaticComponentToolkit
Similar issues
-
textual definition
Difficulty 1/5 Under an hour Newbie friendliness 90/100
geneontology/go-ontology#32653 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
needs design
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Priority/High ready-for-agent Severity/Major Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100