Skip to content

minor: Correct PushButton docstring for command parameter - #530

Open
TheGittyPerson wants to merge 30 commits into
lawsie:masterfrom
TheGittyPerson:minor-docstring-fix
Open

minor: Correct PushButton docstring for command parameter#530
TheGittyPerson wants to merge 30 commits into
lawsie:masterfrom
TheGittyPerson:minor-docstring-fix

Conversation

@TheGittyPerson

Copy link
Copy Markdown

Corrected docstring description for parameter command of the PushButton class from "A string containing the image to display, defaults to None." to "The function to call when the button is pressed."

Closes #528

martinohanlon and others added 30 commits March 22, 2024 15:03
…eight, slant, underline & overstrike) (lawsie#506)

* feat: add weight to Text derived widgets

* test: add tests for Texts

* docs: update docs for Text

* feat: add weight to Drawing.text

* test: add weight and color tests for Drawing.text

* docs: add weight to Drawing.text

* test: move weight_text_test into text_test

* feat: add slant to Text derived widgets

* test: fix tests for weight and add slant

* docs: update for weight and slant

* feat: add underline and overstrike to Text derived widgets

* test: add tests for underline and overstrike

* refactor: cast font properties into a tuple when passing to _set_tk_config

* docs: update docs for underline and overstrike

* fix: change weight to bold booleans and slant to italic booleans

---------

Co-authored-by: Laura Sach <laura.sach@raspberrypi.org>
* Add slider increment, add bold etc text, change deployment method and move docs to gh-deploy (lawsie#514)

* add set box borders example

* lawsie#492 Fixed in docs-src ONLY - please regen docs

* Add pyproject.toml lawsie#495

* Docs style update

* Add `step` to Slider, + tests + docs (lawsie#511)

* Remove deprecated PIL method

* Update dev instructions and add requirements.txt

* Add missing text properties to text derived widgets and containers (weight, slant, underline & overstrike) (lawsie#506)

* feat: add weight to Text derived widgets

* test: add tests for Texts

* docs: update docs for Text

* feat: add weight to Drawing.text

* test: add weight and color tests for Drawing.text

* docs: add weight to Drawing.text

* test: move weight_text_test into text_test

* feat: add slant to Text derived widgets

* test: fix tests for weight and add slant

* docs: update for weight and slant

* feat: add underline and overstrike to Text derived widgets

* test: add tests for underline and overstrike

* refactor: cast font properties into a tuple when passing to _set_tk_config

* docs: update docs for underline and overstrike

* fix: change weight to bold booleans and slant to italic booleans

---------

Co-authored-by: Laura Sach <laura.sach@raspberrypi.org>

* Bump version

* Generate docs via mkdocs gh-deploy instead

* Change docs and add changelog

* remove DS_Store files

* Change version to 1.6.0

* Change version no in pyproject.toml too

* Edit changelog

---------

Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com>
Co-authored-by: james-pcdr <107222062+james-pcdr@users.noreply.github.com>
Co-authored-by: Blindstars <96452556+Blindstars@users.noreply.github.com>

* Fix broken image (lawsie#516)

---------

Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com>
Co-authored-by: james-pcdr <107222062+james-pcdr@users.noreply.github.com>
Co-authored-by: Blindstars <96452556+Blindstars@users.noreply.github.com>
* Fix error in Window docs (lawsie#520)

* add set box borders example

* lawsie#492 Fixed in docs-src ONLY - please regen docs

* Add pyproject.toml lawsie#495

* Docs style update

* Add `step` to Slider, + tests + docs (lawsie#511)

* Remove deprecated PIL method

* Update dev instructions and add requirements.txt

* Add missing text properties to text derived widgets and containers (weight, slant, underline & overstrike) (lawsie#506)

* feat: add weight to Text derived widgets

* test: add tests for Texts

* docs: update docs for Text

* feat: add weight to Drawing.text

* test: add weight and color tests for Drawing.text

* docs: add weight to Drawing.text

* test: move weight_text_test into text_test

* feat: add slant to Text derived widgets

* test: fix tests for weight and add slant

* docs: update for weight and slant

* feat: add underline and overstrike to Text derived widgets

* test: add tests for underline and overstrike

* refactor: cast font properties into a tuple when passing to _set_tk_config

* docs: update docs for underline and overstrike

* fix: change weight to bold booleans and slant to italic booleans

---------

Co-authored-by: Laura Sach <laura.sach@raspberrypi.org>

* Bump version

* Generate docs via mkdocs gh-deploy instead

* Change docs and add changelog

* remove DS_Store files

* Change version to 1.6.0

* Change version no in pyproject.toml too

* Edit changelog

* Move mkdocs.yml into main folder so it can be deployed

* Fix broken image

* Make even with master (lawsie#519)

* Add slider increment, add bold etc text, change deployment method and move docs to gh-deploy (lawsie#514)

* add set box borders example

* lawsie#492 Fixed in docs-src ONLY - please regen docs

* Add pyproject.toml lawsie#495

* Docs style update

* Add `step` to Slider, + tests + docs (lawsie#511)

* Remove deprecated PIL method

* Update dev instructions and add requirements.txt

* Add missing text properties to text derived widgets and containers (weight, slant, underline & overstrike) (lawsie#506)

* feat: add weight to Text derived widgets

* test: add tests for Texts

* docs: update docs for Text

* feat: add weight to Drawing.text

* test: add weight and color tests for Drawing.text

* docs: add weight to Drawing.text

* test: move weight_text_test into text_test

* feat: add slant to Text derived widgets

* test: fix tests for weight and add slant

* docs: update for weight and slant

* feat: add underline and overstrike to Text derived widgets

* test: add tests for underline and overstrike

* refactor: cast font properties into a tuple when passing to _set_tk_config

* docs: update docs for underline and overstrike

* fix: change weight to bold booleans and slant to italic booleans

---------

Co-authored-by: Laura Sach <laura.sach@raspberrypi.org>

* Bump version

* Generate docs via mkdocs gh-deploy instead

* Change docs and add changelog

* remove DS_Store files

* Change version to 1.6.0

* Change version no in pyproject.toml too

* Edit changelog

---------

Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com>
Co-authored-by: james-pcdr <107222062+james-pcdr@users.noreply.github.com>
Co-authored-by: Blindstars <96452556+Blindstars@users.noreply.github.com>

* Fix broken image (lawsie#516)

---------

Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com>
Co-authored-by: james-pcdr <107222062+james-pcdr@users.noreply.github.com>
Co-authored-by: Blindstars <96452556+Blindstars@users.noreply.github.com>

* Fix broken docs

---------

Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com>
Co-authored-by: james-pcdr <107222062+james-pcdr@users.noreply.github.com>
Co-authored-by: Blindstars <96452556+Blindstars@users.noreply.github.com>

* Update deployment instructions

---------

Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com>
Co-authored-by: james-pcdr <107222062+james-pcdr@users.noreply.github.com>
Co-authored-by: Blindstars <96452556+Blindstars@users.noreply.github.com>
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.

Minor docstring mistake in the PushButton class

5 participants