-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Proofread and crosslink examples with immunohistochemistry image. #5231
Proofread and crosslink examples with immunohistochemistry image. #5231
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @mkcor, I just left a small question and a minor request 😉
Co-authored-by: Riadh Fezzani <rfezzani@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Thank you @mkcor 😉
Can another @scikit-image/core dev please review/approve this PR? Once it's merged, I can post my bio-centric announcement on the forum in all peace of mind. Thank you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left one small comment about possibly overriding cross-link text, but if that suggestion is not likely to work, feel free to merge as-is.
the example on how to | ||
:ref:`sphx_glr_auto_examples_color_exposure_plot_ihc_color_separation.py`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had to check the docs to see how this got rendered and notice "Separate" is capitalized, but I don't think it is a big issue if that is not easy to fix.
Does it work if you use the following form?:
:ref:`sphx_glr_auto_examples_color_exposure_plot_ihc_color_separation.py <separate colors in immunohistochemical staining>`.
That would also be robust to future changes to the title in the other file.
link to the rendered doc:
https://1426-2014929-gh.circle-artifacts.com/0/doc/build/html/auto_examples/segmentation/plot_mask_slic.html#sphx-glr-auto-examples-segmentation-plot-mask-slic-py
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, yes. I expected this, for I used the same syntax before, in this example: https://scikit-image.org/docs/dev/auto_examples/applications/plot_3d_structure_tensor.html
I think it makes sense to display a proper title as opposed to a hyperlink within a sentence that should read smoothly... I admit I stayed between two stools in this case: I hesitated between "see tutorial: Title" and adapting the syntax to the example's title. Generally speaking, I'm in favour of using the imperative for example titles (just like commit messages), so there's a standard, plus it's engaging for the reader.
Looks great, thanks @mkcor! |
Description
These minor changes are part of the documentation effort, with a particular focus on the life sciences. Adding a link to another example helps users navigate the gallery.
Checklist
./doc/examples
(new features only)./benchmarks
, if your changes aren't covered by anexisting benchmark
For reviewers
later.
__init__.py
.doc/release/release_dev.rst
.