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

DevCmd's exec* methods should be documented (in .d.ts) #41

Open
PatrickLehnerXI opened this issue Nov 19, 2021 · 2 comments
Open

DevCmd's exec* methods should be documented (in .d.ts) #41

PatrickLehnerXI opened this issue Nov 19, 2021 · 2 comments

Comments

@PatrickLehnerXI
Copy link
Contributor

The process execution functions (execPiped etc.) exposed by the devcmd package aren't currently publicly documented. This should be added to make it easier to understand their usage and behavior, esp. the differences between the various functions we have.

Note: This feedback was provided internally at XITASO, so I'm creating this issue for tracking.

@PatrickLehnerXI
Copy link
Contributor Author

PatrickLehnerXI commented Nov 19, 2021

After short research, I found out that the actual implementations in ProcessExecutor are documented, but this documentation isn't exposed because we re-export the methods of our default ProcessExecutor instance in packages\devcmd\src\process\index.ts.

I'm not sure if we can use @inheritdoc in JSDoc to copy doc-strings from other elements like you can do in C#. If not, we should copy the documentation for the moment to make it accessible to users.

@PatrickLehnerXI
Copy link
Contributor Author

After a little more research and some trying around, I confirmed what I was afraid of: there is no way to copy another element's doc string in a way that VS Code shows inline.

So for the moment, I manually copied the doc strings for the two functions that are already documented, so these are now visible in the IDE and in the .d.ts file. (PR will follow in a moment.)

We are going to need to figure out if we can do more for this in the future. Any ideas are welcome here.

NB: This issue is related to #16, but addresses specifically the re-export of the exec* methods, so I'm keeping this around for the moment.

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

No branches or pull requests

1 participant