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

fix: type check examples in README files #1121

Merged
merged 6 commits into from
Aug 11, 2021
Merged

fix: type check examples in README files #1121

merged 6 commits into from
Aug 11, 2021

Conversation

ry
Copy link
Member

@ry ry commented Aug 11, 2021

Fixes #1120

@LionC
Copy link
Contributor

LionC commented Aug 11, 2021

Nitpick: You added imports to the examples in collections/README.md. I would personally prefer if we would import from the function file directly instead of mod.ts (e.g. import { associateBy } from "./associate_by.ts"). Examples often get copied and modified by users and thus influence how people use it. I would like to encourage users to cherry pick modules instead of downloading everything. This would also be consistent with all JSDoc examples in collections.

It is a bit tedious to replace all that by hand - I would be happy to do it tonight if you want.

Thank you for fixing the README either way!

@bartlomieju
Copy link
Member

Nitpick: You added imports to the examples in collections/README.md. I would personally prefer if we would import from the function file directly instead of mod.ts (e.g. import { associateBy } from "./associate_by.ts"). Examples often get copied and modified by users and thus influence how people use it. I would like to encourage users to cherry pick modules instead of downloading everything. This would also be consistent with all JSDoc examples in collections.

It is a bit tedious to replace all that by hand - I would be happy to do it tonight if you want.

Thank you for fixing the README either way!

If that's the case, what's the point of having mod.ts in the first place?

@bartlomieju bartlomieju changed the title WIP fix markdown type errors fix: type check examples in README files Aug 11, 2021
@ry ry merged commit 455077a into main Aug 11, 2021
@ry ry deleted the fix-markdown branch August 11, 2021 09:28
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.

Unbreak CI - Fix markdown type errors
3 participants