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.

Sign up for GitHub

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

Jump to bottom

📚 Improve documentation #27

Closed
7 tasks done
ckunki opened this issue Jan 16, 2023 · 0 comments · Fixed by #229
Closed
7 tasks done

📚 Improve documentation #27

ckunki opened this issue Jan 16, 2023 · 0 comments · Fixed by #229
Assignees
@Nicoretti
Labels
documentation User guides, tutorials, specifications

Comments

@ckunki
Copy link
Contributor

ckunki commented Jan 16, 2023 •
edited by Nicoretti
Loading

Summary

Make documentation more accessible for developers which are not in depth familiar with the language and tooling.

Tasks

  • Add package description to project metadata (pyproject.toml)
  • Mention requirement to install poetry in documentation
  • Mention workspace layout and standard tools (poetry, nox, etc.) in documentation, or link to toolbox
    (mention cookiecutter)
  • Describe default/standard folder structure for tests
    (mention cookiecutter)
  • Mention noxfile.py and its purpose earlier in documentation (optional)
  • Mention noxconfig.py and its purpose earlier in documentation (optional)
  • Document how mypy, docs etc. could be bypassed/customized if needed
@ckunki ckunki added the documentation User guides, tutorials, specifications label Jan 16, 2023
@Nicoretti Nicoretti changed the title 📚 Proposals for improving documentation 📚 Improve documentation Jan 23, 2023
@Nicoretti Nicoretti self-assigned this Jul 30, 2024
@Nicoretti Nicoretti mentioned this issue Jul 31, 2024
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Nicoretti Nicoretti

Labels
documentation User guides, tutorials, specifications
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve User Documentation exasol/python-toolbox
2 participants
@Nicoretti @ckunki