Skip to content

Manpage: modify the Builder Methods section #4671

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mwichmann
Copy link
Collaborator

@mwichmann mwichmann commented Jan 3, 2025

In clarifying the detail on when a builder's target can be deduced, it seemed like the concept of a single-source builder should be introduced in this context. So now those builders we know are single-source have that notation in their entry in this section. Also mentions that pseudo-Builders may have a different calling sequence.

A chunk of text about dependencies previously appeared after the listing of builder methods, where it would be hard to spot. Moved up into the text before the listing, and integrate in a bit more smoothly.

A couple of very minor typing things adjusted along the way - mainly using single_source consistently as a bool.

There are no functional changes, so no test impacts.

Contributor Checklist:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated CHANGES.txt and RELEASE.txt (and read the README.rst).
  • I have updated the appropriate documentation

@mwichmann mwichmann changed the title Modify the Builder Methods manpage section Manpage: modify the Builder Methods section Jan 3, 2025
When specifying path strings,
&Python; follows the POSIX pathname convention:
if a string begins with the operating system pathname separator
(on Windows both the slash and backslash separator are accepted,
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this info included elsewhere in your modified version? (slash and backslash both accepted on windows for dirsep?)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Been a while... I think it just felt redundant. Didn't think we needed to be defining what an absolute path is.

@mwichmann
Copy link
Collaborator Author

Grumble tried to update this, now CHANGES and RELEASE have reset for the 4.9 release, and github tells me "fatal: The upstream branch of your current branch does not match the name of your current branch." Dunno what that's about...

@mwichmann
Copy link
Collaborator Author

Hmmm, I remember trying to attach the condensed text versions of the manpage output, but they don't seem to be in this issue. Trying again here:

man-new.txt
man-old.txt

In clarifying the detail on when a builder's target can be deduced,
it seemed like the concept of a single-source builder ought to be
introduced in this context. So now those builders we know are
single-source have that notation in their entry in this section.

Also mentions that pseudo-Builders may have a diffeent calling sequence.

A chunk of text about dependencies previously appeared after the
listing of builder methods, where it would be hard to spot. Moved up
into the text before the listing, and integrate in a bit more smoothly.

A couple of very minor typing things adjusted along the way - mainly
using single_source consistently as a bool.

Signed-off-by: Mats Wichmann <[email protected]>
@mwichmann mwichmann force-pushed the doc/builder-methods branch from efe6879 to 7eb0d11 Compare April 7, 2025 19:09
@mwichmann mwichmann moved this to In review in Next Release Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants