Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/documentation typo fixes #110

Merged

Conversation

dosentmatter
Copy link
Contributor

Description

Typo fixes

Checklist

  • I have read CONTRIBUTING.md
  • I have linked all related issues above
  • I have rebased my branch

For bugfixes:

  • [N/A] I have added at least one unit test to confirm the bug have been fixed
  • I have checked and updated TOC and API Docs when necessary

Copy link
Owner

@piotrwitek piotrwitek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for your contribution. Looks good but I would like to bring back some of the removed whitespaces because it removed line-breaks for flow types links.


---

## Flow's Utility Types

### `$Keys<T>`

get the union type of all the keys in an object type `T`
Copy link
Owner

@piotrwitek piotrwitek Oct 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to get back all of these trailing whitespaces in descriptions because it provided a nice line-break to keep the link on a separate line.

Below are more of them, please take care of them too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about using inline HTML <br> tag instead? I think it's a bit more readable and searchable. Also, if we go and do a find&replace of trailing whitespace (or add it to the linter/prettier/editorconfig), we don't have to worry about messing up the double trailing whitespace.

If you prefer the double trailing whitespace in markdown. I can revert it.

Copy link
Owner

@piotrwitek piotrwitek Oct 22, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea with <br />, I love it! 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added back the line breaks with <br>.

Also added alias for Writable<T>. Forgot to do it in #27.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alias looks good, although it's not re-exported from index.ts for public access.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, my bad. I re-exported it in latest commit now.

@dosentmatter dosentmatter force-pushed the bugfix/documentation-typo-fixes branch from dc3f4a1 to 507fec6 Compare October 22, 2019 08:25
`Brand` is not a Flow utility type.
@piotrwitek commented for `Optional` -> `Partial`, it doesn't cost
anything to add an alias and a mention in docs. See:
piotrwitek#112 (comment)

Similarly, the same can be said for `Writable` -> `Mutable`. We already
have `WritableKeys<T>` -> `MutableKeys<T>` alias.
@dosentmatter dosentmatter force-pushed the bugfix/documentation-typo-fixes branch from 127b706 to aae2a03 Compare October 23, 2019 01:15
@piotrwitek piotrwitek merged commit b83fe21 into piotrwitek:master Oct 23, 2019
@piotrwitek
Copy link
Owner

Looks great, thanks for the contribution! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants