Skip to content

docs(fmt): fix printf module doc absense #6424

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

Merged
merged 1 commit into from
Feb 19, 2025

Conversation

0x009922
Copy link
Contributor

@std/fmt/printf module docs are currently absent: https://jsr.io/@std/fmt/doc/printf

It seems that the reason is that the @module JSDoc section happens to be after an import. So, I move the import below and it fixes the issue (checked locally with deno doc).

Anyway, I think deno doc should probably consider this case in some way - either force to put the module doc as the first item in the module, or to allow putting the module doc anywhere in the module.

@0x009922 0x009922 requested a review from kt3k as a code owner February 19, 2025 02:05
@CLAassistant
Copy link

CLAassistant commented Feb 19, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the fmt label Feb 19, 2025
@0x009922 0x009922 force-pushed the fix-printf-module-docs branch from 0dcaf62 to ccd1278 Compare February 19, 2025 02:06
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.04%. Comparing base (431ed58) to head (ccd1278).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6424   +/-   ##
=======================================
  Coverage   96.03%   96.04%           
=======================================
  Files         561      561           
  Lines       42395    42395           
  Branches     6384     6379    -5     
=======================================
+ Hits        40714    40717    +3     
+ Misses       1641     1639    -2     
+ Partials       40       39    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

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

Good findings! LGTM

Anyway, I think deno doc should probably consider this case in some way - either force to put the module doc as the first item in the module, or to allow putting the module doc anywhere in the module.

This sounds like a reasonable suggestion.

cc @crowlKats

@kt3k kt3k merged commit e9888ea into denoland:main Feb 19, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants