Opened 5 years ago

Closed 5 years ago

#19062 closed enhancement (fixed)

cleanup of doc formatting

Reported by: chapoton Owned by:
Priority: minor Milestone: sage-6.9
Component: documentation Keywords:
Cc: Merged in:
Authors: Frédéric Chapoton Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: 3acc7a2 (Commits) Commit: 3acc7a2c7588e4f2975d6beb7d2a3730b3adf064
Dependencies: #19071 Stopgaps:

Description

using 

pcregrep -r --include=".*py$" -M  '.*t[a-df-zA-Z .]::\n[^\#\n]' .

one can find some instances of bad doc formatting. Let us fix them.

Change History (12)

comment:1 Changed 5 years ago by chapoton

  • Branch set to u/chapoton/19062
  • Commit set to 20364202ec3982ceffcdbca1c45c9f4c74da7fdb
  • Status changed from new to needs_review

Last 10 new commits:

​7e0c49fbad doc format in dynamics
​d2fd88bbad doc format in geometry
​c7ab7f7bad doc formatting in rings
​8e4efc8bad doc formatting in interfaces and homology
​acbb73ebad doc formatting in various places
​851b764bad doc formatting in modular
​0e3ee18more bad doc correction
​a39de2byet more bad formatting of doc
​e9af39asome more doc formatting corrections
​2036420some other bad doc formatting

comment:2 Changed 5 years ago by git

  • Commit changed from 20364202ec3982ceffcdbca1c45c9f4c74da7fdb to 656a07cc94828769d38825da9a5de5a9bb321920

Branch pushed to git repo; I updated commit sha1. New commits:

​656a07ctrac #19062 fixed an introduced bug

comment:3 Changed 5 years ago by git

  • Commit changed from 656a07cc94828769d38825da9a5de5a9bb321920 to e7553d59968e9d48f4da1e07c919b104c63b1ef1

Branch pushed to git repo; I updated commit sha1. New commits:

​e7553d5trac #19062 same bug, oops

comment:4 Changed 5 years ago by jdemeyer

Can you please remove all changes from this ticket which are not in docstrings or comments?

Last edited 5 years ago by jdemeyer (previous) (diff)

comment:5 Changed 5 years ago by jdemeyer

  • Status changed from needs_review to needs_work

And also remove the changes to quadratic_forms to avoid a conflict with #18168.

comment:6 Changed 5 years ago by git

  • Commit changed from e7553d59968e9d48f4da1e07c919b104c63b1ef1 to 5756c98a61c56798edec4e98969fd30a6f8e61e5

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

​3d8c1fbtrac #19062 not touching quadratic_forms
​5756c98trac #19062 not longer touching any code

comment:7 Changed 5 years ago by chapoton

  • Status changed from needs_work to needs_review

Thanks, Jeroen, for having a look. I did remove any changes to the code, and also to quadratic forms. By the way, have you received my mail about your patchbot ?

comment:8 Changed 5 years ago by jdemeyer

  • Reviewers set to Jeroen Demeyer
  • Status changed from needs_review to positive_review

comment:9 Changed 5 years ago by vbraun

  • Status changed from positive_review to needs_work

Conflicts with #19071

comment:10 Changed 5 years ago by git

  • Commit changed from 5756c98a61c56798edec4e98969fd30a6f8e61e5 to 3acc7a2c7588e4f2975d6beb7d2a3730b3adf064

Branch pushed to git repo; I updated commit sha1. New commits:

​098b29bDrop #15240 deprecations in lattice_polytope.
​ac51548Add methods returning faces as lattice polytopes.
​2cea458Add methods for polytopes that were available for faces.
​6547b5bStop using deprecated methods in other modules.
​3acc7a2Merge branch 'u/chapoton/19062' of trac.sagemath.org:sage into 19062

comment:11 Changed 5 years ago by chapoton

  • Dependencies set to #19071
  • Status changed from needs_work to positive_review

merge done, it was simple enough that I afford myself to set back to positive review

comment:12 Changed 5 years ago by vbraun

  • Branch changed from u/chapoton/19062 to 3acc7a2c7588e4f2975d6beb7d2a3730b3adf064
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.