Opened 4 years ago

Closed 4 years ago

#17589 closed enhancement (fixed)

Small changes in the developer's manual table of contents

Reported by: ncohen Owned by:
Priority: major Milestone: sage-6.5
Component: documentation Keywords:
Cc: kcrisman Merged in:
Authors: Nathann Cohen Reviewers: John Palmieri
Report Upstream: N/A Work issues:
Branch: 6a2a419 (Commits) Commit: 6a2a4194483f2bdbd370ec441a3fc87a20a29695
Dependencies: #17555 Stopgaps:

Description

This branch does small changes to the table of contents of the developer's manual. Not many, but many things to check:

  • a section entitled 'randomized testing', that was actually only talking (very vaguely) about TestSuite? was turned into a comment in the "Writing testable examples" section.
  • A link that pointed toward it was removed, as its content did not represent what was intended by the link.
  • The chapter "Git and Trac" was split into "Git for Sage development" (which is already rather long) and "Sage Trac and tickets"

I also decreased the depth of some table of contents, after checking that the subsubsections whose name disappear was clearly indicated by their parent's section's name. For this reason, I did not change the depth of some documents like "Coding in Cython", as some people may be looking explicitly for "sig_on/off/check"

Very superficial, but the page gets cleaner and cleaner.

Nathann

Change History (6)

comment:1 Changed 4 years ago by ncohen

  • Branch set to public/17589
  • Dependencies set to #17555
  • Status changed from new to needs_review

comment:2 Changed 4 years ago by git

  • Commit set to 5212473c776529dca597c2bcc38efe15cbdb14b4

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

49ab0bftrac #17555: Remove the dev scripts' documentation
40220f7trac #17555: Some other references to the doc
fdc52e9trac #17555: Merged with #17534
5c37a78trac #17555: remove mention of the dev scripts
805ea9atrac #17555: Merged with 6.5.beta5
5212473trac #17589: Small changes in the developer's manual table of contents

comment:3 Changed 4 years ago by git

  • Commit changed from 5212473c776529dca597c2bcc38efe15cbdb14b4 to 6a2a4194483f2bdbd370ec441a3fc87a20a29695

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

6a2a419#17589: trivial fixes

comment:4 Changed 4 years ago by jhpalmieri

  • Reviewers set to John Palmieri

I made a few small changes. I'm happy with the rest. Switch to positive review if my changes are okay.

comment:5 Changed 4 years ago by ncohen

  • Status changed from needs_review to positive_review

Arggggggggggg !! Sorry for those spaces. I have been warned before. And thank you for the review.

Nathann

comment:6 Changed 4 years ago by vbraun

  • Branch changed from public/17589 to 6a2a4194483f2bdbd370ec441a3fc87a20a29695
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.