Unique package name - Corrective action steps #280
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added the steps discussed in #244 to the documentation in a drop down section because these felt like optional steps and I saw this formatting used in another location in the tutorial.
I separated it into two lists, 'required' and 'recommended.' Not sure if that is a design decision in line with your vision.
Side note: Do we want to reiterate project naming guidelines? I know that during #261 I had issues including hyphens in my project name. You mention already in Make your code installable - Step 1: Set Up the Package Directory Structure that you may have a hyphen in the name of your project, but you then create the project with hatch which manages creating the module directory under source with an underscore instead. I don't think we want to re-create with hatch here, but raising spot where a user can trip in the tutorial and even with my new steps. We can add troubleshooting information to these steps or, what I would recommend, front load the "check that your name is available" work to before creating the project with hatch.