Skip to content

Conversation

@sirosen
Copy link
Member

@sirosen sirosen commented May 29, 2025

I intentionally omitted any doc update when removing MutableScope, but have reconsidered.
I think a minimal stub is still worth adding, and we can enhance it later.


This is a small/minimal entry so that we're guaranteed to have something to build upon.

It intentionally does not go into detail on how to use Scope because these interfaces are being redesigned.


📚 Documentation preview 📚: https://globus-sdk-python--1200.org.readthedocs.build/en/1200/

This is a small/minimal entry so that we're guaranteed to have
something to build upon.

It intentionally does not go into detail on how to use `Scope` because
these interfaces are being redesigned.
@sirosen sirosen added the no-news-is-good-news This change does not require a news file label May 29, 2025
Copy link
Member

@kurtmckee kurtmckee left a comment

Choose a reason for hiding this comment

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

Is it possible to use :class:`Scope` to create a reference link? That may be a helpful addition.

I'm marking this as approved, but this, and an inline suggestion, are my feedback.

Fix some phrasing and link to classes.

Co-authored-by: Kurt McKee <39996+kurtmckee@users.noreply.github.com>
@sirosen
Copy link
Member Author

sirosen commented May 29, 2025

I didn't get nice behavior from :class: without an explicit reference, but I agree it makes a better resulting doc, so I wrote out the full thing to make it work.

@kurtmckee
Copy link
Member

Should this merge to 4.x-dev if it's an upgrading guide that can be applied now?

@sirosen
Copy link
Member Author

sirosen commented May 29, 2025

I don't really want to backport doc changes from 4.x-dev to main/3.x , but it would be possible to write something.

A separate 3.x -specific bit of doc in main would probably be better than backporting this content verbatim.

@sirosen sirosen merged commit 6ac8936 into 4.x-dev May 29, 2025
7 checks passed
@sirosen sirosen deleted the doc-mutable-scope-removal-upgrade branch May 29, 2025 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-news-is-good-news This change does not require a news file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants