Brew: Improve type checking documentation

Created on 10 Nov 2020  路  3Comments  路  Source: Homebrew/brew

Extracted from https://github.com/Homebrew/brew/issues/8991

  • [ ] Improve the documentation in https://docs.brew.sh/Typechecking
  • [ ] Improve tooling/CI output (e.g. brew typecheck) to reference documentation (and vice-versa)
  • [ ] Consider/investigate improving naming here with some of our own aliases to be Type::Signature

Most helpful comment

I'm on it!

All 3 comments

I'm on it!

Consider/investigate improving naming here with some of our own aliases to be Type::Signature

I don't think this will improve readability/understandability when people read Sorbet documentation which only ever mentions T, T::Sig and other methods on the T module but we choose to use a differing name.

I don't think this will improve readability/understandability when people read Sorbet documentation which only ever mentions T, T::Sig and other methods on the T module but we choose to use a differing name.

It'll improve readability for people who read our code but haven't read Sorbet documentation. It is not a realistic expectation that this will happen for everyone who reads Homebrew's code. We should aim to improve the readability of Homebrew's code to newcomers.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Rotonen picture Rotonen  路  4Comments

zelsonia picture zelsonia  路  4Comments

fooness picture fooness  路  4Comments

paanvaannd picture paanvaannd  路  4Comments

thiagodebastos picture thiagodebastos  路  4Comments