python-project-template icon indicating copy to clipboard operation
python-project-template copied to clipboard

Confirm documentation for "incorporating into prior project"

Open drewoldag opened this issue 2 years ago • 1 comments

This is feedback received from a user updating a pre-existing project with the PPT:

The directory layout described in "Incorporating the template into a prior project" is different than that described in "Starting a new project" ... And I think the latter is the correct expected one?

A cursory glance at the docs looked correct, but perhaps I missed some subtleties.

drewoldag avatar Sep 24 '23 13:09 drewoldag

Thanks for starting the issue!

The difference is between this statement in "Incorporating ...":

For example, if your project is in a directory named /science, your source code and tests might look like this:

 /science/src/module.py
 /science/tests/test_module.py

and this in "Starting a new project ..."

If this option is selected the template will create an example module src/{{package_name}}/example_module.py and test file tests/{{package_name}}/test_example_module.py. Defaults to True during simple installation.

They differ in that the "package_name" is in the directory level below "src" for the latter but not the former.

blanton144 avatar Sep 25 '23 16:09 blanton144

The documentation was updated to properly reflect the directory structures that we're looking for. https://lincc-ppt.readthedocs.io/en/latest/source/existing_project.html#a-note-on-directory-structure

drewoldag avatar Aug 26 '24 19:08 drewoldag