Skip to content

Commit 7e4c80f

Browse files
authored
clarify samples noxfile instructions (GoogleCloudPlatform#6634)
cc @Sita04
1 parent 882ab64 commit 7e4c80f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

AUTHORING_GUIDE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -642,9 +642,10 @@ Sample tests are run through [pytest](https://pytest.org). Do not use
642642
643643
__Note:__
644644
645-
**Library repositories:** If you are working on an existing project, a `noxfile.py` will already exist.
645+
**Library repositories:** If you are working on an existing project (meaning that a `samples` directory already exists), a `noxfile.py` will already exist within that `samples` directory.
646+
646647
For new samples, create a new `noxfile.py` and paste the contents of
647-
[noxfile-template.py](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/noxfile-template.py)
648+
[noxfile-template.py](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/noxfile-template.py). Note - there may be a `noxfile.py` in the repo already in the root directory, but this is used for testing the libraries, not the samples, so you will still need to make a samples noxfile.
648649
649650
**python-docs-samples:** As a temporary workaround, each project currently uses first
650651
`noxfile-template.py` found in a parent folder above the current sample. In

0 commit comments

Comments
 (0)