Fix YARD doc for Options

lostisland / faraday

Simple, but flexible HTTP client library, with support for multiple backends.

https://lostisland.github.io/faraday

MIT License

5.71k stars 972 forks source link

Fix YARD doc for Options #1490

Open iMacTia opened 1 year ago

iMacTia commented 1 year ago

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.

olleolleolle commented 1 year ago

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