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
I was wondering if there were any recommendations how to write descriptions?
The spec says it's markdown but is there anything on top of that to link to other fields or indicate parameters and other things?
Like @link and @param in Javadoc?
The text was updated successfully, but these errors were encountered:
As far as I know, no such convention currently exists. However we do have Schema Coordinates now, so using these for this purpose seems wise. I wonder if `Type` and `Type.fieldName` should auto-link to the relevant places in the API?
Thanks for the style guide ❤️
I was wondering if there were any recommendations how to write descriptions?
The spec says it's markdown but is there anything on top of that to link to other fields or indicate parameters and other things?
Like
@link
and@param
in Javadoc?The text was updated successfully, but these errors were encountered: