Skip to content

Update the Kiva GraphicsContext documentation#644

Merged
jwiggins merged 4 commits into
masterfrom
docs/graphics-context
Mar 1, 2021
Merged

Update the Kiva GraphicsContext documentation#644
jwiggins merged 4 commits into
masterfrom
docs/graphics-context

Conversation

@jwiggins
Copy link
Copy Markdown
Member

Most, but not all of #618. This nearly covers all the methods of GraphicsContext.

Comment thread docs/source/kiva/quickref.rst Outdated
Comment thread docs/source/kiva/quickref.rst Outdated
Comment thread docs/source/kiva/quickref.rst Outdated
@jwiggins
Copy link
Copy Markdown
Member Author

jwiggins commented Mar 1, 2021

@corranwebster Thanks for the review. I actually made a major change while you were in the process of reviewing. This documentation now specifically references the AbstractGraphicsContext docstrings via Sphinx autodoc and the automethod directive. I like it much better this way since it keeps the documentation close-ish to the code.

Comment thread docs/source/kiva/quickref.rst Outdated
Copy link
Copy Markdown
Contributor

@rahulporuri rahulporuri left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the docs refactor!

of the following: "gray8", "rgb555", "rgb565", "rgb24", "bgr24", "rgba32",
"argb32", "abgr32", "bgra32".

``interpolation`` determines the interpolation used by scaled image drawing
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not sure why we removed this from the docstring. looks like this isnt available consistently across the various supported backends.

@jwiggins jwiggins merged commit f0d8158 into master Mar 1, 2021
@jwiggins
Copy link
Copy Markdown
Member Author

jwiggins commented Mar 1, 2021

Thanks for the feedback. Should we consider #618 closed now? @corranwebster?

@jwiggins jwiggins deleted the docs/graphics-context branch March 1, 2021 13:59
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.

3 participants