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

Add Debugging Guidance to README #1797

Closed
wants to merge 2 commits into from

Conversation

Burtannia
Copy link

@Burtannia Burtannia commented Jan 11, 2023

Updated the README based on #1796 and enshrined the guidance given by #1711 (comment) into documentation.

Hopefully goes part of the way to addressing #1794.

Also adds a note that if build-system is not specified then it defaults to setuptools whereas the example in the README uses Hatch. As a newcomer to Python I didn't understand this which made it even harder to figure out what was wrong with my pyproject.toml file. To mitigate this for future users I've included a link to the pyproject.toml page of the setuptools documentation.

Contributor checklist
  • Provided the tests for the changes. (N/A, documentation change)
  • Assure PR title is short, clear, and good to be included in the user-oriented changelog
Maintainer checklist
  • Assure one of these labels is present: backwards incompatible, feature, enhancement, deprecation, bug, dependency, docs or skip-changelog as they determine changelog listing.
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

Also add note about build-system defaulting to setuptools
Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can just fix the code since build addressed the issue (not released yet).

Shout-out to @q0w 🎉

@keithly
Copy link

keithly commented Mar 23, 2023

The first paragraph (about what happens when no build tool is specified) is still useful information. I was confused by that the first time I used pip-tools.

@@ -98,6 +98,12 @@ optional dependency ``dev`` that includes ``pytest``:

[project.optional-dependencies]
dev = ["pytest"]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, don't add trailing spaces to lines.

@webknjaz
Copy link
Member

Hi, this would need a migration to Markdown, if still relevant.

@webknjaz webknjaz marked this pull request as draft June 13, 2023 15:42
@atugushev
Copy link
Member

Superseded by #1979.

@atugushev atugushev closed this Sep 5, 2023
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 this pull request may close these issues.

4 participants