Skip to content

Conversation

@nikolasavic3
Copy link
Contributor

docs: fix CycleError and prepare() documentation clarity

Improves clarity and accuracy in the documentation:

  • Clarify that cycle selection is arbitrary in CycleError docstring
  • Improve prepare() documentation to explicitly state call requirements
  • Make prepare() error documentation more structured

docs: fix CycleError and prepare() documentation clarity and
@ghost
Copy link

ghost commented Jan 18, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app
Copy link

bedevere-app bot commented Jan 18, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@bedevere-app
Copy link

bedevere-app bot commented Jan 18, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@bedevere-app
Copy link

bedevere-app bot commented Jan 18, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@bedevere-app
Copy link

bedevere-app bot commented Jan 18, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@picnixz
Copy link
Member

picnixz commented Jan 18, 2025

Some changes are incorrect and are only cosmetic. I suspect this was generated by IA. I am therefore closing it. If you think there is an issue with the current doc, please open a separate issue first (also, the PR is modifying code and typos and I think its scope is incorrect).

@picnixz picnixz closed this Jan 18, 2025
@picnixz
Copy link
Member

picnixz commented Jan 18, 2025

Update: The use of :exec: instead of exc is a typo which can be corrected, but please do so it a separate PR that only fixes typos (as well as a the "a topological order")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants