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

Add/improve documentation about pyproject.toml (first draft by development team) #2377

Closed
stichbury opened this issue Mar 1, 2023 · 0 comments · Fixed by #2427
Closed

Add/improve documentation about pyproject.toml (first draft by development team) #2377

stichbury opened this issue Mar 1, 2023 · 0 comments · Fixed by #2427
Assignees
@ankatiyar
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

Description

I don't feel like I have any grasp of what pyproject.toml is, partly because i'm not a python dev. But I'm seeing it mentioned a fair bit (and we have a page on settings that mentions it in comparison to runtime settings and setup.py). I think it would be a good idea to trawl through the docs and find out what we have and create a section somewhere that is comprehensive/complete as a reference to what it is, how to update it, what we include in it etc.

cc @astrojuanlu as the main inspiration for this, having reviewed my PR for #1985 and spotted the inconsistency.
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Mar 1, 2023
@astrojuanlu astrojuanlu mentioned this issue Mar 1, 2023
Merged
5 tasks
@stichbury stichbury moved this to To Do in Kedro Framework Mar 6, 2023
@stichbury stichbury changed the title Add/improve documentation about pyproject.toml Add/improve documentation about pyproject.toml (first draft by development team) Mar 6, 2023
@ankatiyar ankatiyar self-assigned this Mar 13, 2023
@ankatiyar ankatiyar moved this from To Do to In Progress in Kedro Framework Mar 13, 2023
@ankatiyar ankatiyar mentioned this issue Mar 16, 2023
Merged
5 tasks
@ankatiyar ankatiyar moved this from In Progress to In Review in Kedro Framework Mar 20, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ankatiyar ankatiyar

Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Kedro Framework
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation about pyproject.toml kedro-org/kedro
2 participants
@stichbury @ankatiyar