Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Packaging tutorial: Directory structure unclear #340

Closed
gunnarvoet opened this issue Dec 15, 2023 · 1 comment · Fixed by #346
Closed

Packaging tutorial: Directory structure unclear #340

gunnarvoet opened this issue Dec 15, 2023 · 1 comment · Fixed by #346

Comments

@gunnarvoet
Copy link

The guide puts __init__.py and refraction.py directly into src/

```bash
touch src/__init__.py
```
Place `refraction.py`, our code from the previous section, next to it, at
`src/refraction.py`.

whereas the directory structure listing has src/example/...

.
├── pyproject.toml
├── src
│ └── example
│ ├── __init__.py
│ └── refraction.py

@henryiii
Copy link
Collaborator

Oops, that’s a mistake. __init__.py should never be directly in src.

henryiii added a commit that referenced this issue Dec 19, 2023
* fix: correct tutorial src layout (#340)

* Update docs/pages/tutorials/packaging.md

---------

Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
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 a pull request may close this issue.

2 participants