Skip to content

docs: correct tmpfile example output#1475

Closed
KirtiRamchandani wants to merge 1 commit into
google:mainfrom
KirtiRamchandani:docs/tmpfile-output-name
Closed

docs: correct tmpfile example output#1475
KirtiRamchandani wants to merge 1 commit into
google:mainfrom
KirtiRamchandani:docs/tmpfile-output-name

Conversation

@KirtiRamchandani

Copy link
Copy Markdown

Problem

The tmpfile('f2.txt') example in docs/api.md shows a returned path ending in foo.txt, which does not match the argument.

Root cause

The example comment appears to have been copied from the tmpdir('foo') example above it, while tmpfile(name) returns a path using the provided file name.

Solution

Update the example output to end in f2.txt.

Tests run

  • npm exec --yes prettier -- --check docs/api.md
  • git diff --check

Fixes #1469

@KirtiRamchandani

Copy link
Copy Markdown
Author

Closing this since there are already earlier open PRs covering the same one-line docs fix (#1470 and #1474).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(api): tmpfile('f2.txt') example shows wrong output filename (foo.txt)

1 participant