Skip to content

Document auto-login disabling#1127

Merged
derek-globus merged 1 commit intoglobus:mainfrom
derek-globus:fix-app-config-doc-ivar
Jan 14, 2025
Merged

Document auto-login disabling#1127
derek-globus merged 1 commit intoglobus:mainfrom
derek-globus:fix-app-config-doc-ivar

Conversation

@derek-globus
Copy link
Copy Markdown
Contributor

@derek-globus derek-globus commented Jan 14, 2025

  • Documentation didn't explain what happened if GlobusAppConfig.token_validation_error_handler was set to None (or explain that it could be set to None). Added that explanation.

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

Copy link
Copy Markdown
Member

@sirosen sirosen left a comment

Choose a reason for hiding this comment

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

I think those infix type declarations in ivar blocks for Sphinx might not be needed, since sphinx can read annotations. But let me look at fixing that after this merges, so that we can have the doc content itself updated.

@derek-globus derek-globus merged commit 1a33571 into globus:main Jan 14, 2025
@sirosen
Copy link
Copy Markdown
Member

sirosen commented Jan 14, 2025

FWIW: I was wrong. autodoc_typehints doesn't support loading the annotations off of dataclass fields.
I'd like to get that working, but it probably requires a custom plugin. :(

@derek-globus derek-globus deleted the fix-app-config-doc-ivar branch January 14, 2025 23:30
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