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

Consider collapsing summary and description properties into just description for certain node types #70

Open
rsek opened this issue Aug 14, 2024 · 0 comments

Comments

@rsek
Copy link
Owner

rsek commented Aug 14, 2024

Collections and oracles have both. Originally, summary was for the short text and description was for longer text.

This is intended to hint the expected text size to developers, but since both properties are optional, in practice people just do something like const foo = node.summary ?? node.description. Longer descriptions from the book also have implications re: licensing.

I think it'd be better to just use description, but at the length currently used by summary.

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

1 participant