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.

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

JSDoc and typescript declaration file (*.d.ts) #163

Open
WoonchanCho opened this issue Jan 28, 2021 · 6 comments · May be fixed by #165
Open

JSDoc and typescript declaration file (*.d.ts) #163

WoonchanCho opened this issue Jan 28, 2021 · 6 comments · May be fixed by #165

Comments

@WoonchanCho
Copy link
Contributor

Hi @pieper and other maintainers,
Thank you so much for initiating and maintaining this great project.
I am trying to test this library out as much as I can in our team's projects and enjoy using it now.

This is not a production issue at all but a kind of improvement suggestion.
As you know, the source code itself is not fully documented.
It would be great to have JsDoc comments at the JavaScript source level.

This will help a lot to users who use a modern editor that provides an IntelliSense with the JsDocs comments.
Even more than that, it will also make creating & maintaining the typescript declaration files (*.d.ts) extremely easy.

I will be happy to add the JsDoc comment to all the active JavaScript sources in the project.
For sure, this will be (should be) no harm to the functionalities of the library because this work will only add comments package.json for the two DevDependencies: JsDoc and TypeScript (Typescript will be used only for creating declaration files)

My only concern is that I'm not a native English speaker, there might be some awkward expression used.
If I add those JsDoc comments, can you review them and update if there is anything weird?

Thank you so much.
@hackermd
Copy link
Member

@pieper I have Typescript type declarations for parts of the library, which I would be happy to share/add and which we could build on.

@pieper
Copy link
Collaborator

pieper commented Jan 28, 2021

Hi @WoonchanCho and @hackermd - these sound like great improvements to me. The core code is pretty stable at this point so now would be a good time to put in some more documentation and ts help. I'd be happy to review and edit 👍

@hackermd
Copy link
Member

Great! @WoonchanCho I have type annoations for the sr subpackage. We could then start from there. I will prepare a pull request.

@WoonchanCho
Copy link
Contributor Author

Sounds great! Then I will wait till @hackermd's pull request is merged into the master branch (or a new branch for this work) and begin working after it.

@WoonchanCho
Copy link
Contributor Author

Hi @hackermd, I just wanted to check the status on the type annotation for the sr subpackage. If you are busy for something or need to take more time I might begin to work and you can add on your work on it.
I'm opened to anything so feel free to let me know.

@hackermd
Copy link
Member

hackermd commented Feb 2, 2021

@WoonchanCho I have a type declarations file. It's not yet complete and I have yet tested its distribution via the npm. I will push what I have and then we can discuss outstanding TODO items. OK?

@hackermd hackermd linked a pull request Feb 2, 2021 that will close this issue
Draft
@hackermd hackermd linked a pull request Feb 2, 2021 that will close this issue
Addition of typescript type declarations #165
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Addition of typescript type declarations dcmjs-org/dcmjs
3 participants
@pieper @hackermd @WoonchanCho