Add --hide-private to omit anything with visibility private

AaronC81 / sord

Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files

https://sord.aaronc.cc

MIT License

304 stars 18 forks source link

Add --hide-private to omit anything with visibility private #146

Closed dorner closed 2 years ago

dorner commented 2 years ago

Currently, adding a @!visibility private tag does not affect sord's output. This PR adds a --hide-private option to not include anything tagged this way. Some examples might be monkey patching existing code (where our patch might inadvertently override better-documented existing methods), or more complex metaprogramming that sord might be confused by.

AaronC81 commented 2 years ago

Apologies, I missed this it was opened! This is a great improvement - thanks for your contribution.

dorner commented 2 years ago

Nice, thanks!