docs: add sorbet documentation #8386
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vidusheeamoli
force-pushed
the
documentation
branch
from
91066f8
to
2c1e5d0
Compare
|
Going to add another section which deals with how to resolve type errors reported by Sorbet ASAP. |
mistydemeo
reviewed
Aug 19, 2020
There was a problem hiding this comment.
This is a great start!
I'd like to see a bit more of an introduction here. Having some links to the Sorbet documentation and its "how to get started" documentation would be great. We want to make sure that Homebrew developers who are familiar with the Homebrew codebase, but not with Sorbet, have a place to get some guidance on where to go from here.
MikeMcQuaid
reviewed
Aug 19, 2020
docs/Typechecking.md
Outdated
| natively. RBI files for all gems are auto-generated using | ||
| [Tapioca](https://github.com/Shopify/tapioca#tapioca). We can also create a RBI | ||
| file to help Sorbet understand dynamic definitions. | ||
| For eg: Sorbet assumes that `Kernel` is not necessarily included in our modules |
There was a problem hiding this comment.
Suggested change
| For eg: Sorbet assumes that `Kernel` is not necessarily included in our modules | |
| For example: Sorbet assumes that `Kernel` is not necessarily included in our modules |
vidusheeamoli
force-pushed
the
documentation
branch
3 times, most recently
from
240fe22
to
eb137e5
Compare
MikeMcQuaid
approved these changes
Aug 21, 2020
(cherry picked from commit 022571489a0f94ed54a0908167b553592cfe3277)
vidusheeamoli
force-pushed
the
documentation
branch
from
eb137e5
to
cba751a
Compare
|
Let's merge for now and can always address additional comments in a follow-up PR. Nice work again @vidusheeamoli! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
brew stylewith your changes locally?brew testswith your changes locally?Documentation for Sorbet.