Skip to content

Reordering of User Guide's Table of Contents#3402

Merged
abravalheri merged 3 commits into
pypa:mainfrom
codeandfire:toc-ordering
Jun 23, 2022
Merged

Reordering of User Guide's Table of Contents#3402
abravalheri merged 3 commits into
pypa:mainfrom
codeandfire:toc-ordering

Conversation

@codeandfire

@codeandfire codeandfire commented Jun 23, 2022

Copy link
Copy Markdown
Contributor

Summary of changes

Reorganized the User Guide's Table of Contents

This mostly follows the scheme given here, with the following exceptions:

  • "Controlling files in the distribution" is kept not immediately after the "Package Discovery" page, but rather towards the end, because a lot of the material in that page overlaps with material given in the "Package Discovery" and "Data Files" pages. Therefore, it seems to me that this page should be read after the other two pages have been
    read.
  • "Development Mode" is kept not towards the end but introduced close to the beginning, because readers might want to start using it early on in their projects.
  • "Building Extension Modules" is kept immediately after the "Entry Points" and "Data Files" pages, since it is the last major topic we would like to discuss. The two topics that follow ("Specifying your Project's Version" and "Controlling Files in the Distribution") are lighter topics that can be read later by users after they have been able to get a basic start with their projects.
  • Have retained the pages "Extending or Customizing Setuptools", "Configuring Setuptools using setup.cfg files" and "Configuring Setuptools using pyproject.toml files" for now.

Have also removed the quotes around the heading of the page on Development Mode, it seems unnecessary.

Pull Request Checklist

This mostly follows the scheme given
[here](pypa#3400 (reply in thread)),
with the following exceptions:
 - "Controlling files in the distribution" is kept not immediately after
   the "Package Discovery" page, but rather towards the end, because a
   lot of the material in that page overlaps with material given in the
   "Package Discovery" and "Data Files" pages. Therefore, it seems to me
   that this page should be read _after_ the other two pages have been
   read.
 - "Development Mode" is kept not towards the end but introduced close
   to the beginning, because readers might want to start using it early
   on in their projects.
 - "Building Extension Modules" is kept immediately after the "Entry
   Points" and "Data Files" pages, since it is the last major topic we
   would like to discuss. The two topics that follow ("Specifying your
   Project's Version" and "Controlling Files in the Distribution") are
   lighter topics.
 - Have retained the pages "Extending or Customizing Setuptools",
   "Configuring Setuptools using setup.cfg files" and "Configuring
   Setuptools using pyproject.toml files" for now.
@codeandfire codeandfire marked this pull request as ready for review June 23, 2022 06:06
@abravalheri

Copy link
Copy Markdown
Contributor

Thank you very much @codeandfire for the reorganisation.

Do you believe this logic makes more sense? When I did the suggestion I was just trying to find a sequence that would make logic sense when guiding the user through learning. But I did not double check with the actual pages 🤣

If you belive that is the way to go, I am happy to merge!

@codeandfire

Copy link
Copy Markdown
Contributor Author

Well @abravalheri, the way I think about this reorganization is the sequence a person starting a new Python package would follow. Package Discovery and Dependencies Management would probably be the first in this sequence, since these two are essential to package any Python project. Next they should know about development mode / editable installs so that they can get started with development. The next three topics namely Entry Points, Data Files and Extension Modules are involved topics that may or may not be relevant to their specific project. Finally there are two minor topics namely Versioning and Controlling Files in the Distribution which cover some finer details of the packaging process.

I did not strictly follow your suggestion :) but I feel this is a reasonable way of ordering the pages.

@abravalheri

Copy link
Copy Markdown
Contributor

Thanks @codeandfire. I think you put more thought on this than I did, so I am very happy with that!

@abravalheri abravalheri merged commit 669be5e into pypa:main Jun 23, 2022
@codeandfire codeandfire deleted the toc-ordering branch June 23, 2022 09:01
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.

2 participants