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

multi-entry: temporarily change docs to singular "module" #862

Merged
merged 3 commits into from
Sep 18, 2020

Conversation

KATT
Copy link
Contributor

@KATT KATT commented Sep 17, 2020

I spent ten minutes with adding globs and comma-separated paths before giving up going into the issues and searching/finding #175 / #367.

Maybe delete the (s) until the issue is resolved to prevent other people from doing the same. :)

I spent ten minutes with adding globs and comma-separated paths before giving up going into the issues and searching/finding jaredpalmer#175 / jaredpalmer#367. 

Maybe delete the `(s)` until the issue is resolved to prevent other people from doing the same. :)
@vercel
Copy link

vercel bot commented Sep 17, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/formium/tsdx/kq6i13w1b
✅ Preview: https://tsdx-git-fork-katt-patch-1.formium.vercel.app

@KATT KATT changed the title Replace "file(s)" with "file" Replace "module(s)" with "module" Sep 17, 2020
@agilgur5 agilgur5 added the topic: multi-entry Related to multi-entry support label Sep 17, 2020
@agilgur5 agilgur5 changed the title Replace "module(s)" with "module" multi-entry: temporarily change docs to singular "module" Sep 17, 2020
Copy link
Collaborator

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

Agreed, I fell victim to the same problem then dug into the code and wrote #367 (which was like my second or third PR as a contributor), hopefully this helps a bit.

The API docs are supposed to be equivalent to the --help of each subcommand, so you'll need to modify the help text for both build and watch too:
https://github.com/formium/tsdx/blob/d4c3bb220bba4ab26545b9d1a09ef646f031bc63/src/index.ts#L366

@agilgur5 agilgur5 added the scope: docs Documentation could be improved. Or changes that only affect docs label Sep 17, 2020
@KATT
Copy link
Contributor Author

KATT commented Sep 18, 2020

Done, I simply used the "edit"-buttons in GitHub, guess you can squash when you merge?

Copy link
Collaborator

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the contribution @KATT . Yep, will squash merge this and edit commit message etc

@agilgur5 agilgur5 merged commit ac98a73 into jaredpalmer:master Sep 18, 2020
@agilgur5
Copy link
Collaborator

@allcontributors please add @KATT for docs

@allcontributors
Copy link
Contributor

@agilgur5

I've put up a pull request to add @KATT! 🎉

paul-vd pushed a commit to EezyQuote/tsdx that referenced this pull request Dec 1, 2020
…r#862)

- multi-entry is not currently supported due to a bug, PR to fix has yet to be merged
- so modify docs that suggest it is supported from plural "Entry module(s)" to singular

I spent ten minutes with adding globs and comma-separated paths before giving up going into the issues and searching/finding the bug and PR to fix the bug

Maybe delete the `(s)` until the issue is resolved to prevent other people from doing the same. :)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Documentation could be improved. Or changes that only affect docs topic: multi-entry Related to multi-entry support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants