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 Tabulator.ipynb to dynamically show correct version number of Tabulator #7053

Merged
merged 2 commits into from
Aug 8, 2024

Conversation

Coderambling
Copy link
Contributor

Doc says Tabulator 5.5 is used, but Tabulator.py shows 6.2.1 is used.

Changed version number in doc to 6.2.1 .

https://github.com/holoviz/panel/blob/main/panel%2Fmodels%2Ftabulator.py#L19

Doc says Tabulator 5.5 is used, but Tabulator.py shows 6.2.1 is used.

Changed version number in doc to 6.2.1 .

https://github.com/holoviz/panel/blob/main/panel%2Fmodels%2Ftabulator.py#L19
Copy link

codecov bot commented Aug 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.80%. Comparing base (94df573) to head (758ad27).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7053      +/-   ##
==========================================
+ Coverage   81.76%   81.80%   +0.03%     
==========================================
  Files         326      326              
  Lines       48315    48394      +79     
==========================================
+ Hits        39505    39588      +83     
+ Misses       8810     8806       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hoxbro
Copy link
Member

hoxbro commented Aug 1, 2024

Let's try automating this like done in #5243

@Coderambling
Copy link
Contributor Author

Coderambling commented Aug 1, 2024

Yes that would be great! Was going through my head when I made the PR. Didn't know that was possible.

Should this PR still go through in the mean time? I would say yes, as it corrects the info and creates a window to apply automation.

I don't think I will be able to apply the PR you mention to automate it, as I am not familiar with that code.

Copy link
Member

@hoxbro hoxbro left a comment

Choose a reason for hiding this comment

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

I don't think I will be able to apply the PR you mention to automate it, as I am not familiar with that code.

It is not hard to do! You just need to change the placeholder and update the conf.py file with the following:

	version_replace = {
		...  # Other versions
		"{{TABULATOR_VERSION}}": "6.2.1",
    }

examples/reference/widgets/Tabulator.ipynb Outdated Show resolved Hide resolved
@Coderambling
Copy link
Contributor Author

Ok added it to conf.py

2d9d5e5

Adopted code suggestion by @hoxbro. Separately added version number to conf.py as stated

Co-authored-by: Simon Høxbro Hansen <simon.hansen@me.com>
@Coderambling
Copy link
Contributor Author

Hm the line below causes the tests to fail with exit code 1.

When I comment it out, tests are successful.

@hoxbro , should it be:

from panel.io.models.tabulator

instead?

from panel.models.tabulator import TABULATOR_VERSION

@hoxbro
Copy link
Member

hoxbro commented Aug 3, 2024

Please combine this and #7062, and let us take it from there.

You can confirm the import is correct with python -c "from panel.models.tabulator import TABULATOR_VERSION; print(TABULATOR_VERSION)" in an environment with panel installed.

@philippjfr
Copy link
Member

Guess I'll just merge both.

@philippjfr philippjfr merged commit 23a1fee into holoviz:main Aug 8, 2024
14 of 15 checks passed
@Coderambling
Copy link
Contributor Author

Thank you. I was unable to combine the 2 PR's into one.

@Coderambling Coderambling changed the title Update Tabulator.ipynb to show correct version number of Tabulator Update Tabulator.ipynb to dynamically show correct version number of Tabulator Sep 9, 2024
@Coderambling
Copy link
Contributor Author

Coderambling commented Sep 9, 2024

Note: Is conf.py updated automatically / manually with the latest version?

Should we do the same in other docs like for Perspective etc., so that correct library versions are always automatically shown in the various docs?

@MarcSkovMadsen
Copy link
Collaborator

+1 on showing version number in docs for components where it is relevant to study documents of js library to be able to use.

@Coderambling
Copy link
Contributor Author

Which other docs would this apply to?

Perspective
VTK
VTKJS
...?

@MarcSkovMadsen
Copy link
Collaborator

  • Deck.gl/ PyDeck, Echarts/ PyEcharts, Katex/ MathJax, Plotly, Altair & Vega, Vizzu,

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.

4 participants