docs(api): fix tmpfile('f2.txt') example output path#1487
Open
KirtiRamchandani wants to merge 1 commit into
Open
docs(api): fix tmpfile('f2.txt') example output path#1487KirtiRamchandani wants to merge 1 commit into
KirtiRamchandani wants to merge 1 commit into
Conversation
The inline comment incorrectly showed foo.txt even though tmpfile() joins the provided name verbatim under the temp directory.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes incorrect inline comment in the
tmpfile()docs example.Fixes #1469
Problem
docs/api.mdshowed the result path ending infoo.txteven though the argument is'f2.txt'.Root cause
Copy/paste error.
tempfile()insrc/goods.tsusespath.join(tempdir(), name), preserving the basename.Fix
Update the comment to
.../f2.txt.Testing
Verified against
tempfile()implementation insrc/goods.ts(docs-only change).