Skip to content

Conform to doc requirements so that the docs look more beautiful#35069

Merged
vbraun merged 22 commits intosagemath:developfrom
alexjbest:alexjbest/doc-fixes
Mar 13, 2023
Merged

Conform to doc requirements so that the docs look more beautiful#35069
vbraun merged 22 commits intosagemath:developfrom
alexjbest:alexjbest/doc-fixes

Conversation

@alexjbest
Copy link
Copy Markdown
Contributor

These are mostly either of the form of unindenting text that was accidentally put in a code block, or correctly adding :: or EXAMPLES:: so that docs render nicely.

📚 Description

📝 Checklist

  • I have made sure that the title is self-explanatory and the description concisely explains the PR.
  • I have linked an issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

Copy link
Copy Markdown
Collaborator

@tscrim tscrim left a comment

Choose a reason for hiding this comment

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

All are just a minor formatting issue of .:: displaying at .: in the doc. Either change to . :: (for . output) or :: (for : output).

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 11, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.01 🎉

Comparison is base (52a81cb) 88.57% compared to head (971c0b1) 88.59%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #35069      +/-   ##
===========================================
+ Coverage    88.57%   88.59%   +0.01%     
===========================================
  Files         2140     2140              
  Lines       397273   397273              
===========================================
+ Hits        351891   351945      +54     
+ Misses       45382    45328      -54     
Impacted Files Coverage Δ
src/sage/algebras/free_algebra_quotient.py 98.63% <ø> (ø)
src/sage/algebras/iwahori_hecke_algebra.py 82.69% <ø> (ø)
src/sage/algebras/quatalg/quaternion_algebra.py 92.68% <ø> (ø)
src/sage/categories/cartesian_product.py 97.77% <ø> (ø)
src/sage/categories/domains.py 100.00% <ø> (ø)
src/sage/categories/examples/sets_cat.py 100.00% <ø> (ø)
src/sage/categories/magmas.py 97.63% <ø> (ø)
src/sage/coding/abstract_code.py 94.20% <ø> (ø)
src/sage/coding/guruswami_sudan/interpolation.py 100.00% <ø> (ø)
src/sage/coding/linear_code_no_metric.py 96.65% <ø> (ø)
... and 98 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@github-actions
Copy link
Copy Markdown

Documentation preview for this PR is ready! 🎉
Built with commit: 971c0b1

Copy link
Copy Markdown
Contributor

@fchapoton fchapoton left a comment

Choose a reason for hiding this comment

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

looks good, thanks

@vbraun vbraun merged commit 7db7c89 into sagemath:develop Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants