Skip to content

Tuto display - #2012

Merged
fspindle merged 23 commits into
lagadic:masterfrom
sjourdro:tuto-display
Sep 9, 2026
Merged

Tuto display#2012
fspindle merged 23 commits into
lagadic:masterfrom
sjourdro:tuto-display

Conversation

@sjourdro

@sjourdro sjourdro commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

I finished the tutorial on displaying images.

The links are all correct.
The commands work and the code examples give the expected results.
I am not totally sure on the explications I gave however.

Please review it and give your impressions.

@fspindle @rolalaro

@sjourdro
sjourdro marked this pull request as draft September 8, 2026 07:22
@sjourdro
sjourdro marked this pull request as ready for review September 8, 2026 08:18

@rolalaro rolalaro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@sjourdro please address my preliminary comments

Comment thread modules/python/doc/rst/tutorials/image/tutorial-image-display.rst
Comment thread modules/python/doc/rst/tutorials/image/tutorial-image-display.rst
Comment thread modules/python/doc/rst/tutorials/image/tutorial-image-display.rst
Comment thread modules/python/examples/image/tutorial-image-display.py Outdated
Comment thread modules/python/examples/image/tutorial-image-display.py Outdated
Comment thread modules/python/examples/image/tutorial-image-display-scaled-default.py Outdated
Comment thread modules/python/examples/image/tutorial-image-display-scaled-auto.py Outdated
Comment thread modules/python/examples/image/tutorial-image-display-matplotlib.py Outdated
@sjourdro
sjourdro marked this pull request as draft September 9, 2026 07:37
@sjourdro
sjourdro marked this pull request as ready for review September 9, 2026 07:47
@rolalaro

rolalaro commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

@sjourdro when you link towards a Python class, you should use:

:py:class:`~visp.core.Display`

instead of a link towards the online documentation, it permits to work with local files only.
The ~ indicates to Sphinx to only display the class name instead of the full denomination.

You can also link towards a function such as:

:py:func:`visp.python.display_utils.get_display`

in this case I would suggest to keep the full denomination.

See this post to link towards a method of a class.

Thank you in advance for applying the required changes =)

@sjourdro
sjourdro marked this pull request as draft September 9, 2026 08:29
@sjourdro
sjourdro marked this pull request as ready for review September 9, 2026 09:49
@sjourdro
sjourdro marked this pull request as draft September 9, 2026 09:51
@sjourdro
sjourdro marked this pull request as ready for review September 9, 2026 10:01
@sjourdro
sjourdro requested a review from rolalaro September 9, 2026 12:29

@rolalaro rolalaro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The links are now correctly using Sphinx cross references, and the Python code have the expected behavior. Well done !

@sjourdro
sjourdro marked this pull request as draft September 9, 2026 13:15
@sjourdro
sjourdro marked this pull request as ready for review September 9, 2026 13:31
@sjourdro
sjourdro marked this pull request as draft September 9, 2026 13:33
@sjourdro
sjourdro marked this pull request as ready for review September 9, 2026 13:36
@fspindle
fspindle merged commit f7e4b55 into lagadic:master Sep 9, 2026
16 of 17 checks passed
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.

3 participants