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

Support documenting metadata #308

Open
0b1kn00b opened this issue Apr 29, 2023 · 6 comments
Open

Support documenting metadata #308

0b1kn00b opened this issue Apr 29, 2023 · 6 comments

Comments

@0b1kn00b
Copy link

I'd prefer not to have to hard code github links all over when pointing to general documentation from specific implementations, are there any thoughts about documenting metadata in general?

@Simn
Copy link
Member

Simn commented Apr 29, 2023

I'm reading what you write and somehow can't figure out what you're asking. Could you clarify what you mean?

@kLabz
Copy link
Contributor

kLabz commented Apr 29, 2023

Like adding support for @see foo.bar.Baz.someField in doc comments?

@0b1kn00b
Copy link
Author

0b1kn00b commented Apr 29, 2023

Something like that, a url for a metadata instance that can be used as an appendix/glossary

@vega0
Copy link

vega0 commented Jun 27, 2023

how you generating the documentation?

@vega0
Copy link

vega0 commented Jun 27, 2023

I'd prefer not to have to hard code github links all over when pointing to general documentation from specific implementations, are there any thoughts about documenting metadata in general?

uh?

@0b1kn00b
Copy link
Author

0b1kn00b commented Jun 27, 2023 via email

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

4 participants