-
Notifications
You must be signed in to change notification settings - Fork 13
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
Adds add_thumbnail helper #145
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good and nice spot on a use case we didn't meet yet. I don't consider my one comment to be a blocker to merge :)
**kwargs (): see ResourceItem. | ||
|
||
Returns: | ||
anno_page (AnnotationPage): the AnnotationPage with an Annotation and ResourceItem attached. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this needs to be updated as the return for this helper is currently the canvas object.
It might be nice to return the ResourceItem instead in case further manipulation on it is desired (otherwise, the user should already have the canvas object in order to use this helper, so the return might be redundant).
Any idea why the docs build is blowing up? I can run that same command locally without errors. |
It says a cyclic reference detected. It builds in strict mode for PRs, so it might be that it will be ok when merged. I'll pull locally and see if I can get any more useful diagostics. |
Strict mode also worked fine for me locally 😕 |
Seems to be an issue with the use of uuid somewhere?
|
Looks like the latest version of Griffe (released yesterday) has a change to how alias resolution works: https://github.com/mkdocstrings/griffe/blob/master/CHANGELOG.md. I will pin the requirements to the previous version as a temporary fix. |
I've opened an issue in the griffe repo: mkdocstrings/griffe#123 |
No description provided.