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

doc: fixing the crc32 function on documentation #55898

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kevinuehara
Copy link
Contributor

In this PR I'm adjusing the documentation of zlib. The crc32 is not a method of ZlibBase. It is a standalone function of the module.
Mentioned in 55800

@RedYetiDev @ErickWendel @aduh95

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem. labels Nov 17, 2024
doc/api/zlib.md Outdated Show resolved Hide resolved
@RedYetiDev
Copy link
Member

Why was I pinged?

@kevinuehara
Copy link
Contributor Author

@RedYetiDev Sorry! I pinged you because you commented on the previous PR closed

@lpinca lpinca added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Nov 21, 2024

Provides an object enumerating Zlib-related constants.

## `zlib.crc32(data[, value])`
Copy link
Member

Choose a reason for hiding this comment

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

While I notice the zlib.constants is not in alphabetical order here, the zlib.crc32(...) section should likely be moved up to appear before zlib.flush(...)

Copy link

Choose a reason for hiding this comment

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

@jasnell Isn't the point of this PR that zlib.crc32 is not a subsection of zlib.ZlibBase, but a section on the same level as zlib.constants? I think it's alphabetically sorted correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. zlib Issues and PRs related to the zlib subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants