Improve score of JSR symbol

[fzn0x]

What is the feature you are proposing?

Reference: https://jsr.io/docs/writing-docs#symbol-documentation

Now (when this issue was created) we only have 19% of the code documented, we can start with the public methods first before focusing on the private ones. In future, after we done with the JSR symbol, we can continously improve the code documentation.

[EdamAme-x]

Progress
#2836

[fzn0x]

Lets get 80% ! 👍

[yusukebe]

Regarding the JSR score, I think it's okay to cover only public APIs. "comment" is not always good for private methods or properties. Perhaps you may find the spec by looking at the code or test, not the comment. Honestly, I don't like over-writing the comment. So, I think it's enough to write docs for the API marked as export, and we shouldn't be eager to get 100 points.

[EdamAme-x]

Regarding the JSR score, I think it's okay to cover only public APIs. "comment" is not always good for private methods or properties. Perhaps you may find the spec by looking at the code or test, not the comment. Honestly, I don't like over-writing the comment. So, I think it's enough to write docs for the API marked as export, and we shouldn't be eager to get 100 points.

I agree. If we should be eager to get 100 points, it is too difficult to maintenance code.

[fzn0x]

I think it's enough to write docs for the API marked as export, and we shouldn't be eager to get 100 points.

Yes, I think public APIs alone is enough to get 80 points.

[EdamAme-x]

Went up 3% by #2836
The main API is now mostly jsdoc added.

[HeyITGuyFixIt]

@yusukebe

Regarding the JSR score, I think it's okay to cover only public APIs.

The scoring is only concerned about the "presence of a README file, module documentation, and documentation for public functions and types." So documentation on private functions and types shouldn't affect the score. It looks like they updated the wording on the score page to clarify this. It is currently showing that 25% of exported symbols are documented.

[yusukebe]

@HeyITGuyFixIt

Thanks for the information! Currently, the score of @hono/hono is 76%. It's good to be higher but I think we don't have to be eager for it. The user will use Hono if it's not a bad score.