Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style guide: add descriptions #13

Open
martinbonnin opened this issue Nov 29, 2023 · 2 comments
Open

Style guide: add descriptions #13

martinbonnin opened this issue Nov 29, 2023 · 2 comments

Comments

@martinbonnin
Copy link

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?

@benjie
Copy link
Owner

benjie commented Nov 29, 2023

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?

@martinbonnin
Copy link
Author

That'd be cool!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants