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

Add a description #19

Open
RikudouSage opened this issue Nov 28, 2024 · 2 comments
Open

Add a description #19

RikudouSage opened this issue Nov 28, 2024 · 2 comments

Comments

@RikudouSage
Copy link

RikudouSage commented Nov 28, 2024

Any chance you'd consider adding a description to the fields? Could be implemented for example using decorators, would look like this:

interface SomeType {
  fieldWithNoDescription: string;

  @Description("some description")
  fieldWithDescription: string;
}
@3rd
Copy link
Owner

3rd commented Nov 28, 2024

Yes, any suggestions on how to render the descriptions?
I think comment blocks might be better for multi-line, maybe with a special prefix ex ///

@RikudouSage
Copy link
Author

I think multiline could work with template strings:

@Description(`
     Some
  multiline
description
`)

But yeah, comments are fine as well.


I was thinking of rendering them as a 3rd column, but I'm not great at UX, so maybe it's a bad idea.

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