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

Better types in docs #1950

Merged
merged 1 commit into from
Jul 18, 2023

Conversation

RunDevelopment
Copy link
Member

Changes:

  • Don't show type for dropdowns. Showing all options is sufficient. We don't allow connections to dropdowns anyway.
  • Added "Type:" before the type.
  • Made "Options:" italic.
  • Improved type tooltips. They are now derived from the type and use the same underlying explaining logic as type errors. So any improvement we make towards explaining doc types will as improve error messages. In fact, I had to improve the explaining and type error messages now use natural language more often.

image

image
image
image
image
image
image

Copy link
Member

@joeyballentine joeyballentine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

@joeyballentine joeyballentine merged commit d87dbf1 into chaiNNer-org:main Jul 18, 2023
4 checks passed
@RunDevelopment RunDevelopment deleted the better-docs-types branch July 18, 2023 14:54
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

Successfully merging this pull request may close these issues.

None yet

2 participants