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.

Sign up for GitHub

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

Jump to bottom

Fix YARD doc for Options #1490

Open
iMacTia opened this issue Feb 4, 2023 · 1 comment
Open

Fix YARD doc for Options #1490

iMacTia opened this issue Feb 4, 2023 · 1 comment
Labels
documentation

Comments

@iMacTia
Copy link
Member

iMacTia commented Feb 4, 2023

Issue description

In #1489, we changed the definition of Options (Structs) from Env < Options.new to Env = Options.new { }.
This makes our Options structs compatible with Sorbet, but it breaks their YARD auto-generate docs.
See the PR thread for more details.
@iMacTia iMacTia mentioned this issue Feb 4, 2023
Merged
@olleolleolle
Copy link
Member

Good trade-off!
Let us see if it is possible to get both!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@olleolleolle @iMacTia