这是indexloc提供的服务，不要输入任何密码
Skip to content

Add examples in the documentation #148

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 5 commits into from
Closed

Add examples in the documentation #148

wants to merge 5 commits into from

Conversation

@ruizb
Copy link
Contributor

@ruizb ruizb commented Sep 26, 2020 •
edited
Loading

🎁 Pull Request

  • Used a clear / meaningful title for this pull request
  • Tested the changes in your own code (on your projects)
  • Added / Edited tests to reflect changes (tst folder)
  • Have read the Contributing part of the Readme
  • Passed npm test

Fixes

Nothing.

Why have you made changes?

To improve the documentation and hopefully bring more people to the joys of type-level programming.

What changes have you made?

I added examples in the documentation blocks of some types.

I'll probably add more examples in the near future, I want to make sure these kinds of changes are welcome!

What tests have you updated?

None.

Is there any breaking changes?

No.

Anything else worth mentioning?

While playing with L.CompulsoryKeys, I got some strange results:

import {L} from 'ts-toolbelt'

type test0 = L.CompulsoryKeys<[1, 2, 3]> // {0: 1, 1: 2, 2: 3}

I was expecting to get 0 | 1 | 2 instead. I also tested with [1, 2, 3?] and got the exact same result, while expecting 0 | 1. Nonetheless I added the example, but I'm pretty sure the result is wrong, and there are no tests for this mapped type (there's a "cf. O.CompulsoryKeys" in the tst/List.ts file).

Also, I didn't follow the 7th step of the contributing guide (the one that mentions npm run release -- --no-tags) since it's only about documentation.

@ruizb ruizb requested a review from millsp as a code owner September 26, 2020 10:39
@millsp
Copy link
Owner

millsp commented Sep 26, 2020

Amazing, thank you so much Benoit 🥳

@millsp
Copy link
Owner

millsp commented Oct 6, 2020

I will merge this in the upcoming version 9. Thanks!

@ruizb
Copy link
Contributor Author

ruizb commented Oct 7, 2020

My pleasure! I'll continue as soon as I can 😌

@Semigradsky
Copy link

Semigradsky commented Nov 5, 2020

I will merge this in the upcoming version 9

Hi! Why you want to wait major version update?
It is just documentation change, it looks like patch version change.

@millsp
Copy link
Owner

millsp commented Nov 5, 2020

I'm dropping support for version 8, as we continue to improve as TS introduces new features and concepts. I'm planning to take a few days to do this (working on next branch), I planned to batch all of this into the next release.

@millsp
Copy link
Owner

millsp commented Nov 5, 2020

Which is very soon, waiting for upstream ts 4.1.

@stale
Copy link

stale bot commented Jan 6, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Jan 6, 2021
@Semigradsky
Copy link

Semigradsky commented Jan 6, 2021

some activity

@stale stale bot removed the wontfix This will not be worked on label Jan 6, 2021
@millsp
Copy link
Owner

millsp commented Jan 29, 2021

Merged! Thank you!

@millsp millsp closed this Jan 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@millsp millsp Awaiting requested review from millsp millsp is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ruizb @millsp @Semigradsky