Skip to content
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

Update scrap documentation #923

Merged
merged 3 commits into from Mar 24, 2019

Conversation

Projects
None yet
2 participants
@charlesej
Copy link
Contributor

charlesej commented Mar 22, 2019

Overview of changes:

  • Changed wording/formatting/code examples
  • Added/fixed code links and markdown
  • Added python reST field info for all functions
Update scrap documentation
- Changed wording/formatting/code examples
- Added/fixed code links and markdown
- Added python reST field info for all functions
@illume

This comment has been minimized.

Copy link
Member

illume commented Mar 23, 2019

Nice one.

@illume

illume approved these changes Mar 23, 2019

Copy link
Member

illume left a comment

I wonder if we can mention examples/scrap_clipboard.py in here?

I'm not sure of the best way to link to examples, but the draw.rst includes it like this:

.. ## pygame.draw ##

.. figure:: code_examples/draw_module_example.png
   :scale: 50 %
   :alt: draw module example

   Example code for draw module.

.. literalinclude:: code_examples/draw_module_example.py
Show resolved Hide resolved docs/reST/ref/scrap.rst Outdated

charlesej added some commits Mar 23, 2019

@charlesej

This comment has been minimized.

Copy link
Contributor Author

charlesej commented Mar 23, 2019

I've added a link to the examples page and to the code in GitHub.

@illume illume merged commit 175ef0e into pygame:master Mar 24, 2019

1 of 2 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@charlesej charlesej deleted the charlesej:update-scrap-docs branch Mar 24, 2019

@illume illume referenced this pull request Mar 31, 2019

Closed

1.9.5 release notes. #561

4 of 4 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.