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: add warning about #55764 #55876

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

Conversation

tjaisson
Copy link

Adds a warning about #55764 to the documentation.

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Nov 16, 2024
@aduh95
Copy link
Contributor

aduh95 commented Nov 16, 2024

I find the proposed text not very informative, to the point I don't think it makes sense to add it. If we're adding a link, we should give some clues so users know if they might want to click the link or not – and is it actually useful to link to the issue tracker rather than simply explaining the situation?

@tjaisson
Copy link
Author

tjaisson commented Nov 16, 2024

The effects of this problem may be difficult to notice because the recursion may appear to work fine at first glance (I talk about my own experience). So for me the most important point was to quickly add a warning.
That said, I agree with you that the link is probably useless for most users.
Perhaps the relevant information would be : Don't use it unless you're running a patched version. With a link to a review below reviewing the affected and fixed versions.

@RedYetiDev
Copy link
Member

I don't think adding a link is relevant at all. There have been plenty of bugs in the past, but AFAIK there hasn't been explicit links in the docs. I believe that it'll only confuse users as to think, "Why did they add a link in an update, but not fix it?". I'd be more beneficial to spend time fixing the issue rather than updating the documentation to work around it, IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants