Skip to content

Conversation

@DavidBAEpstein
Copy link
Collaborator

  • DOC: Edit metadata to remove hidden cells. Fix one heading
  • MAINT: Remove incorrect initial ?>?. Delete incorect double quotes.
  • MAINT: Remove incooect double quotes. Improve text. Improve code comment.
  • MAINT: Remove incorrect initial ">"
  • MAINT: insert empty line before list several times
  • MAINT: Insert spaces round backticked words and phrases, where appropriate

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Jul 26, 2022

Codecov Report

Merging #432 (6b0311c) into develop (6e1f151) will not change coverage.
The diff coverage is n/a.

❗ Current head 6b0311c differs from pull request most recent head c66e03b. Consider uploading reports for the commit c66e03b to get more accurate results

@@           Coverage Diff            @@
##           develop     #432   +/-   ##
========================================
  Coverage    98.63%   98.63%           
========================================
  Files           60       60           
  Lines         5916     5916           
  Branches      1053     1053           
========================================
  Hits          5835     5835           
  Misses          69       69           
  Partials        12       12           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@John-P John-P added the documentation Improvements or additions to documentation label Jul 27, 2022
@DavidBAEpstein
Copy link
Collaborator Author

A summary of changes since the develop version of 05-patch-prediction.ipynb

  1. All hidden cells unhidden. Hidden cells are visible in jnb rendering, but not in rtd. In rtd, hidden cells incorrectly change sections to subsections with consequent incorrect fontsize. It also messes up readthedocs indexing.
  2. "pip install tiatoolbox" was changed to
    "pip install git+https://github/.com/TissueImageAnalytics/tiatoolbox.git@develop" in order to get the legend right ( @Srijay's correction to visualization.py). These commands have substantial output, which I found beneficial, and so I abandoned the use of "tail --lines 1", which, in any case should be changed to "tail -n 1" to avoid the special gnu syntax.
  3. Message about restarting the runtime was clarified
  4. Made clean-up after run bullet-proof, for example withstanding abnormal termination in the middle of a run. Defined a Python helper function "rmdir", to avoid using bash "rm -rf".
  5. Checked that everything ran correctly, including the correct legend, on Colab with GPU, on Colab without GPU, and on Macbook without GPU.
  6. Removed the use of greater than signs ">" which are usually rendered literally in rtd
  7. Improved some text cells
  8. Lists must be preceded and followed by cell boundary or empty line, to give correct rendering in rtd.
  9. Ran "make html" on the doc-05 branch, and visually compared the notebook rendering with
    https://tia-toolbox.readthedocs.io/en/doc-05/_notebooks/05-patch-prediction.html

Copy link
Member

@shaneahmed shaneahmed left a comment

Choose a reason for hiding this comment

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

Thanks @DavidBAEpstein
Looks good to me. I have kept hidden cells as the issue with headings is not with hidden cells but to do with nbsphinx rendering. This will be resolved with myst-nb.

@shaneahmed shaneahmed merged commit 2720662 into develop Sep 6, 2022
@shaneahmed shaneahmed deleted the doc-05 branch September 6, 2022 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants