Add doc details for $Shape. #6694
Closed
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
rickyp-uber
reviewed
Aug 6, 2018
| @@ -578,6 +578,23 @@ function makeParamStore<T>(storeClass: Class<ParamStore<T>>, data: T): ParamStor | |||
| (makeParamStore(ParamStore, 1): ParamStore<boolean>); // failed because of the second parameter | |||
| ``` | |||
|
|
|||
| ## `Shape<T>` <a class="toc" id="toc-shape" href="#toc-shape"></a> | |||
|
|
|||
| Copies the shape of the type supplied, but marks every field optional. | |||
There was a problem hiding this comment.
Maybe not use "Shape" in the definition of "Shape"? How does "Copies an existing type and makes each of its properties optional" sound?
There was a problem hiding this comment.
User is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
wchargin
added a commit
to wchargin/flow
that referenced
this pull request
Aug 8, 2018
Summary: Docs for `$Shape` were introduced in facebook#6694, but that PR had three major errors: - the section was not linked from the table of contents - the type `$Shape<T>` was misspelled as `Shape<T>` in the header - the code block was not terminated, so the entirety of the rest of the page was marked as code, [like this][1]—clearly no one previewed the page before deploying! [1]: https://archive.fo/CqH7D#87% Test Plan: After much effort, managed to get the website to build locally. Visited <http://localhost:8080/en/docs/types/utilities/#toc-shape> and checked that the three issues mentioned above are all fixed. wchargin-branch: fix-shape-docs
Closed
wchargin
added a commit
to wchargin/flow
that referenced
this pull request
Aug 8, 2018
Summary: Docs for `$Shape` were introduced in facebook#6694, but that PR had three major errors: - the section was not linked from the table of contents - the type `$Shape<T>` was misspelled as `Shape<T>` in the header - the code block was not terminated, so the entirety of the rest of the page was marked as code, [like this][1]—clearly no one previewed the page before deploying! [1]: https://archive.fo/CqH7D#87% Closes facebook#6692. Test Plan: After much effort, managed to get the website to build locally. Visited <http://localhost:8080/en/docs/types/utilities/#toc-shape> and checked that the three issues mentioned above are all fixed. (For posterity, steps taken to get the build working are listed here: <facebook#6708 (comment)>.) wchargin-branch: fix-shape-docs
wchargin
added a commit
to wchargin/flow
that referenced
this pull request
Aug 8, 2018
Summary: Docs for `$Shape` were introduced in facebook#6694, but that PR had four major errors: - the section was not linked from the table of contents; - the type `$Shape<T>` was misspelled as `Shape<T>` in the header; - the code block did not have `// @flow`, so lacked error annotations; - the code block was not terminated, so the entirety of the rest of the page was marked as code, [like this][1]—clearly no one previewed the page before deploying! [1]: https://archive.fo/CqH7D#87% This patch fixes those errors. While in the area, we clean up the comments reading "Error" and "OK" to (a) eliminate the horizontal scrollbar and (b) match the style elsewhere on the page. Closes facebook#6692. Test Plan: After much effort, managed to get the website to build locally. Visited <http://localhost:8080/en/docs/types/utilities/#toc-shape> and checked that the four issues mentioned above are all fixed. (For posterity, steps taken to get the build working are listed here: <facebook#6708 (comment)>.) wchargin-branch: fix-shape-docs
facebook-github-bot
pushed a commit
that referenced
this pull request
Aug 10, 2018
Summary: Docs for `$Shape` were introduced in #6694, but that PR had four major errors: - the section was not linked from the table of contents; - the type `$Shape<T>` was misspelled as `Shape<T>` in the header; - the code block did not have `// flow`, so lacked error annotations; - the code block was not terminated, so the entirety of the rest of the page was marked as code, [like this][1]—clearly no one previewed the page before deploying! [1]: https://archive.fo/CqH7D#87% This patch fixes those errors. While in the area, we clean up the comments reading "Error" and "OK" to (a) eliminate the horizontal scrollbar and (b) match the style elsewhere on the page. Closes #6692. Pull Request resolved: #6708 Reviewed By: panagosg7 Differential Revision: D9249420 Pulled By: jbrown215 fbshipit-source-id: a54de957c5ac744ce7c483c4be0cbfd182dfee02
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.