Skip to content

Sort docstring by precedence - #445

Merged
philippjfr merged 5 commits into
holoviz:masterfrom
ahuang11:docstring_precedence
May 13, 2021
Merged

philippjfr merged 5 commits into
holoviz:masterfrom
ahuang11:docstring_precedence

Conversation

@ahuang11

Copy link
Copy Markdown
Contributor

@coveralls

coveralls commented Nov 14, 2020 •

Copy link
Copy Markdown

Coverage Status

Coverage increased (+0.1%) to 79.753% when pulling acfa0b4 on ahuang11:docstring_precedence into 5d67174 on holoviz:master.

Comment thread param/ipython.py
@ahuang11

Copy link
Copy Markdown
Contributor Author

Okay thanks for the suggestion. It now follows: https://panel.holoviz.org/gallery/param/precedence.html
image

Comment thread param/ipython.py Outdated
Comment thread param/ipython.py Outdated
@ahuang11

Copy link
Copy Markdown
Contributor Author

Any other changes needed?

@jbednar

jbednar commented Nov 17, 2020

Copy link
Copy Markdown
Member

Nope; looks great! I think it's ready to merge once the tests are passing. Not sure what's up with those, and probably won't have a chance to look at that today.

@ahuang11

Copy link
Copy Markdown
Contributor Author

I wonder if tests are failing because the order changed?

==================================
Parameters changed from their default values are marked in red.
Soft bound values are marked in cyan.
C/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None
NameValue   Type     Bounds      Mode  
v    4    Number                C RW  
w    4    Number                C RO  
u    4    Number                V RW  
z    4    Number  (-1, 100)     V RW  
x   None  String              V RW AN 
y    4    Number  (-1, None)    V RW  
Parameter docstrings:
=====================
u: < No docstring available >
v: < No docstring available >
w: < No docstring available >
x: < No docstring available >
y: < No docstring available >
z: < No docstring available >
RAW STRING:
"\x1b[1;32mParameters of 'TestClass' instance\n==================================\n\x1b[0m\n\x1b[1;31mParameters changed from their default values are marked in red.\x1b[0m\n\x1b[1;36mSoft bound values are marked in cyan.\x1b[0m\nC/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None\n\n\x1b[1;34mNameValue   Type     Bounds      Mode  \x1b[0m\n\nv    4    Number                C RW  \nw    4    Number                C RO  \nu    4    Number                V RW  \nz    4    Number  (-1, 100)     V RW  \nx   None  String              V RW AN \ny    4    Number  (-1, None)    V RW  \n\n\x1b[1;32mParameter docstrings:\n=====================\x1b[0m\n\n\x1b[1;34mu: < No docstring available >\x1b[0m\n\x1b[1;31mv: < No docstring available >\x1b[0m\n\x1b[1;34mw: < No docstring available >\x1b[0m\n\x1b[1;31mx: < No docstring available >\x1b[0m\n\x1b[1;34my: < No docstring available >\x1b[0m\n\x1b[1;31mz: < No docstring available >\x1b[0m"
FAIL
test_bad_compute_default (tests.API0.testlistselector.TestListSelectorParameters) ... WARNING:param.ParameterizedMetaclass: Use method 'params' via param namespace 

@jlstevens

Copy link
Copy Markdown
Contributor

I wonder if tests are failing because the order changed?

I think that is possible. Otherwise, I like this PR and would be happy to see it merged once the tests are green!

@jbednar jbednar added this to the v1.10.2 milestone May 10, 2021
@philippjfr

Copy link
Copy Markdown
Member

Will merge and fix up the tests separately.

@philippjfr
philippjfr merged commit f2e6985 into holoviz:master May 13, 2021
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.

5 participants