Skip to content

docs(api): fix tmpfile('f2.txt') example to show matching output filename#1470

Open
kiwigitops wants to merge 2 commits into
google:mainfrom
kiwigitops:docs/fix-tmpfile-example
Open

docs(api): fix tmpfile('f2.txt') example to show matching output filename#1470
kiwigitops wants to merge 2 commits into
google:mainfrom
kiwigitops:docs/fix-tmpfile-example

Conversation

@kiwigitops
Copy link
Copy Markdown

Fixes #1469.

In docs/api.md under the tmpfile() section (line 331), the inline comment showed an output filename that didn't match the input argument — tmpfile('f2.txt') was annotated with a path ending in foo.txt. Since tempfile(name) in src/goods.ts does path.join(tempdir(), name), the result for tmpfile('f2.txt') ends in f2.txt.

- f2 = tmpfile('f2.txt')   // /os/based/tmp/zx-1ra1iofojgg/foo.txt
+ f2 = tmpfile('f2.txt')   // /os/based/tmp/zx-1ra1iofojgg/f2.txt

@google-cla
Copy link
Copy Markdown

google-cla Bot commented May 18, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@kiwigitops
Copy link
Copy Markdown
Author

@googlebot I have signed the CLA!

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