You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[X] Bug Report => Please search GitHub for a similar issue or PR before submitting
[ ] Feature Request => Please ensure feature is not already in progress
[ ] Support Request => Please do not submit support requests here, instead see: https://discourse.oss.antheminc.com/
Current Behavior
Developer guesses what classes/methods/vars do to the best of their ability via var-name/method-name/class-name. May also result in more time than necessary spent looking through nimbus documentation.
Expected Behavior
"Production" code for a library used at scale would expect updated & accurate javadoc for all methods/classes/variables available to the developer using the framework.
Javadoc auto-published to an endpoint for easy external reference.
Add example calls/values/usage notes.
Why would the developer use this method/var/class?
What are the default values/function/behavior?
What state does the method/class/var mutate or return?
What does the class add to the Nimbus framework that is not available in other classes?
Benefits
Saves time for any developer implementing features with the framework a lot of guess & check time.
More accurate coding to best practices, smaller chance of mis-using functionality for unintended purposes.
Better developer experience, easier to use, more likely to rope in external contributions or suggestions.
How to Reproduce the Issue
Steps to Reproduce
Hover over elements/classes/variables represented by the nimbus framework... nothing except namespace and method/var/class prototype shows up.
Code Snippet
Environment Details
Nimbus Version:
current.
Browser:
N/A
The text was updated successfully, but these errors were encountered:
Issue Details
Type of Issue (check one with "X")
Current Behavior
Developer guesses what classes/methods/vars do to the best of their ability via var-name/method-name/class-name. May also result in more time than necessary spent looking through nimbus documentation.
Expected Behavior
"Production" code for a library used at scale would expect updated & accurate javadoc for all methods/classes/variables available to the developer using the framework.
Javadoc auto-published to an endpoint for easy external reference.
Benefits
How to Reproduce the Issue
Steps to Reproduce
Hover over elements/classes/variables represented by the nimbus framework... nothing except namespace and method/var/class prototype shows up.
Code Snippet
Environment Details
current.
N/A
The text was updated successfully, but these errors were encountered: