fix indentation in property mixins #13514

mosc9575 · 2023-11-05T18:39:02Z

This pull requests is part of my list of changes for the docs.

issues: addresses fix layout issues in docs #13276

This time the focus is on the property mixins page.

old version	suggested version

I added dedent from textwrap because the generated rst-parte by the BokehPropDirective looked like below.

.. attribute:: fill_alpha docs/reference/core/property_mixins
    :module: bokeh.core.property_mixins
    :annotation: = 1.0

    :Type: :class:`~bokeh.core.properties.AlphaSpec`\ 
    
    
    An alpha value to use to fill paths with.

        Acceptable values are floating-point numbers between 0 and 1 (0 being
        transparent and 1 being opaque).

This indentation created a quote block.

I also changed

A wrong indentation in HoverTools
A not working Example code block in CustomJSHover
And a missing word in the property_mixins.py

codecov · 2023-11-05T18:49:51Z

Codecov Report

Merging #13514 (e1ca494) into branch-3.4 (8265814) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

@@              Coverage Diff               @@
##           branch-3.4   #13514      +/-   ##
==============================================
- Coverage       92.63%   92.63%   -0.01%     
==============================================
  Files             321      321              
  Lines           20397    20395       -2     
==============================================
- Hits            18894    18892       -2     
  Misses           1503     1503

bryevdv · 2023-11-05T19:59:38Z

@mattpap is Bokeh-CI / unit-test (ubuntu-latest, 3.9) a real failure? I think I have seen that failing on every recent PR.

mattpap · 2023-11-05T20:01:32Z

I just submitted an issue for that. Yes, it started failing on multiple PRs and is persistent.

bryevdv · 2023-11-05T20:07:32Z

src/bokeh/core/property/color.py

    Acceptable values are floating-point numbers between 0 and 1 (0 being
    transparent and 1 being opaque).
-    """
+    """)


TBH I think just dedenting the actual text inside the triple quoted string all the way would be fine, rather than actually calling the dedent function. It's just not a habit I'd want to get into in general (these things do contribute to import time), so I'd rather head it off from the start.

Alternatively, I'd probably myself just define ALPHA_DEFAULT_HELP outside the class and then assign that to default_help

I decided to go for the variable ALPHA_DEFAULT_HELP and COLOR_DEFAULT_HELP and get rid of some duplicated documentation, too. Hope it is fine now.

bryevdv · 2023-11-05T20:07:49Z

src/bokeh/core/property/dataspec.py

    Acceptable values are floating-point numbers between 0 and 1 (0 being
    transparent and 1 being opaque).
-    """
+    """)


same comment re: dedent

bryevdv · 2023-11-05T20:08:53Z

Thanks @mosc9575 just one minor comment about avoiding the dedent calls.

…T_HELP

mosc9575 · 2023-11-05T23:09:04Z

@bryevdv After opening the PR I updated by conda environment and with the latest version I am not able to build the docs. I was trying to build the complete docs with the latest changes and updates like Spinhx > 7.0 and I am getting an error ValueError: Missing SRI hash for version 2.2.2. Is this related to #13488. As far as I can tell there is not 2.2.2.json or any 2.2.x.json. Is there something missing or how can I solve this issue?

bryevdv · 2023-11-07T17:57:15Z

Thank @mosc9575 !

* fix indentation of default strings with dedent from textwrap * add missing words in property_mixins.py * fix indentation in tools.py * remove dedent block and introduce ALPHA_DEFAULT_HELP and COLOR_DEFAULT_HELP * change order of imports

* Add a regression test for issue #8890 (#13572) * Don't register keyup twice in `AutocompleteInput` (#13577) * Don't register keyup twice in AutocompleteInput * Pin pytest-asyncio to version 0.21.1 * Link sub-coordinate and context dependent ranges in RangesUpdate (#13603) * Fix support for global/local imported stylesheets (#13559) * Compatibility with Chromium 110 * Robustify unit tests involving browser output (#13602) * Multiple density estimate plot (#13527) * added sample data * created density plot * added gallery images and json * sorted import order * clarified plot description * refactored plotting file * changed tick formatting style * deleted unused import * deleted whitespace * additional file refactoring * pyramid example plot (#13596) * added sample data * created plot and added plot description * added gallery image * minor edits * modified plot title * added bar labels to plot * removed whitespace * post-review * changed color palette * added plot image * added extra tick markers * Remove unnecessary arcTo calls in round_rect (#13627) * Update license and copyright statements to 2024 (#13630) * Use `ruff` to ban `typing_extensions` at the top-level (#13633) * Upgrade to ruff 0.1.11 * Enable TID rules and disable TID252 for now * Ban `typing_extensions` module at the top-level * Remove test_no_typing_extensions_common * Import `typing_extensions` under `TYPE_CHECKING` in `*.pyi` * Correctly handle transforms in SVG arcTo (#13640) * ban PIL and other imports with ruff (#13639) * fix indentation in sphinx extentions (#13549) * fix indentation in property mixins (#13514) * fix indentation of default strings with dedent from textwrap * add missing words in property_mixins.py * fix indentation in tools.py * remove dedent block and introduce ALPHA_DEFAULT_HELP and COLOR_DEFAULT_HELP * change order of imports * Restored broken API links (#13528) * restored broken API links * modified broken API path * Allow newer tornado and pandas in test-minimal-deps (#13635) * Add release notes * Update switcher.json * avoid_Sphinx ThemeError and set Sphinx to a minimum of 7.1.0 (#13560) * fix some sphinx warnings (#13609) * fix some sphinx warnings * don't make the first line bold * fix warnings caused by sampledata (#13613) * add forensic glass and emissions to sampledata.rst (#13615) --------- Co-authored-by: Azaya <99359668+Azaya89@users.noreply.github.com> Co-authored-by: Ian Thomas <ianthomas23@gmail.com> Co-authored-by: Bryan Van de Ven <bryan@bokeh.org> Co-authored-by: Moritz Schreiber <68053396+mosc9575@users.noreply.github.com>

Moritz Schreiber added 3 commits November 5, 2023 19:20

fix indentation of default strings with dedent from textwrap

82efb21

add missing words in property_mixins.py

b11cedb

fix indentation in tools.py

2fcc4d5

mosc9575 added tag: component: docs status: ready labels Nov 5, 2023

bryevdv reviewed Nov 5, 2023

View reviewed changes

Moritz Schreiber added 2 commits November 5, 2023 23:16

remove dedent block and introduce ALPHA_DEFAULT_HELP and COLOR_DEFAUL…

50a25a1

…T_HELP

change order of imports

e1ca494

bryevdv approved these changes Nov 7, 2023

View reviewed changes

bryevdv added reso: completed status: accepted and removed status: ready labels Nov 7, 2023

bryevdv added this to the 3.4 milestone Nov 7, 2023

bryevdv merged commit fc7d189 into bokeh:branch-3.4 Nov 7, 2023
28 of 30 checks passed

mattpap added the type: bug label Nov 7, 2023

mosc9575 deleted the 13276_fix_indentation_in_property_mixins branch November 12, 2023 08:30

bryevdv mentioned this pull request Nov 28, 2023

Backports for 3.3.2 #13553

Merged

4 tasks

mosc9575 mentioned this pull request Jan 5, 2024

Backports for 3.3.3 #13624

Merged

22 tasks

mattpap added the NEEDS BACK PORT label Jan 5, 2024

mattpap removed this from the 3.4 milestone Jan 8, 2024

mattpap added this to the 3.3.3 milestone Jan 8, 2024

mattpap removed the NEEDS BACK PORT label Jan 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix indentation in property mixins #13514

fix indentation in property mixins #13514

mosc9575 commented Nov 5, 2023

codecov bot commented Nov 5, 2023 •

edited

bryevdv commented Nov 5, 2023

mattpap commented Nov 5, 2023

bryevdv Nov 5, 2023 •

edited

mosc9575 Nov 5, 2023

bryevdv Nov 5, 2023

bryevdv commented Nov 5, 2023

mosc9575 commented Nov 5, 2023

bryevdv commented Nov 7, 2023

fix indentation in property mixins #13514

fix indentation in property mixins #13514

Conversation

mosc9575 commented Nov 5, 2023

codecov bot commented Nov 5, 2023 • edited

Codecov Report

bryevdv commented Nov 5, 2023

mattpap commented Nov 5, 2023

bryevdv Nov 5, 2023 • edited

Choose a reason for hiding this comment

mosc9575 Nov 5, 2023

Choose a reason for hiding this comment

bryevdv Nov 5, 2023

Choose a reason for hiding this comment

bryevdv commented Nov 5, 2023

mosc9575 commented Nov 5, 2023

bryevdv commented Nov 7, 2023

codecov bot commented Nov 5, 2023 •

edited

bryevdv Nov 5, 2023 •

edited