Opened 4 years ago

Closed 4 years ago

#19354 closed defect (fixed)

Minor typos in 6.9

Reported by: jmantysalo Owned by:
Priority: minor Milestone: sage-6.10
Component: documentation Keywords:
Cc: darij Merged in:
Authors: Frédéric Chapoton, Jori Mäntysalo Reviewers: Jori Mäntysalo, Frédéric Chapoton
Report Upstream: N/A Work issues:
Branch: 9185acb (Commits) Commit: 9185acb5a14a539051b615d8526303e6cdeff499
Dependencies: Stopgaps:

Description (last modified by jmantysalo)

This is a container ticket for minor documentation typos found in version 6.9, to be fixed for 6.10. I'll add them here, if I am not doing another ticket for same part of Sage. Of course others can also make additions to this.

  • coding_in_python.rst, links in "experimental" part broken.
  • sage.rings.rational.integer_rational_power, output section.
  • linear_extensions.html, broken link in first SEEALSO block.
  • frank_network() on posets, x \ge y should be p \ge q.
  • graphs.py, part "generators": somehow add a mention about graphs() there, like we now have graphs(n). Add link to common graphs page.

digraphs:

  • is_directed_acyclic, too much indentation on output block
  • level_sets, too much indentation on output block
  • reverse_edges, vertical spacing in input block.

in combinat/interval_posets (and elsewhere):

wrong formatting ,`` in the first lines of from_binary_trees and from_dyck_words

Change History (42)

comment:1 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:2 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:3 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:4 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:5 Changed 4 years ago by jmantysalo

  • Cc darij added
  • Milestone changed from sage-6.9 to sage-6.10

Darij: Can you confirm that in frank_network() "for each p and q in P such that x≥y, an edge from (0,p) to (1,q)." should be "for each p and q in P such that p≥q, an edge from (0,p) to (1,q)."

comment:6 Changed 4 years ago by darij

Confirmed. Good catch!

comment:7 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:8 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:9 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:10 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:11 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:12 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:13 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:14 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:15 Changed 4 years ago by chapoton

  • Description modified (diff)

comment:16 Changed 4 years ago by chapoton

  • Branch set to public/19354
  • Commit set to e8ddba6b2d1b09ea9738d20876bc961114d6eb19

New commits:

e8ddba6trac #19534 remove bad instances of ,``

comment:17 Changed 4 years ago by git

  • Commit changed from e8ddba6b2d1b09ea9738d20876bc961114d6eb19 to 61e2c908fdd1af8d900b9dba958aa7e1866c593b

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

61e2c90trac #19534 doc cleanup for digraphs

comment:18 Changed 4 years ago by chapoton

  • Description modified (diff)

comment:19 Changed 4 years ago by git

  • Commit changed from 61e2c908fdd1af8d900b9dba958aa7e1866c593b to 57813c98b975878d6830b750367b8956d2136741

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

57813c9trac #19354 correction of frank network

comment:20 Changed 4 years ago by chapoton

  • Description modified (diff)

comment:21 Changed 4 years ago by git

  • Commit changed from 57813c98b975878d6830b750367b8956d2136741 to 5a6d106d6682d06bed98fc8399eb2da3bec7952e

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

5a6d106trac #19354 correct output in rational.pyx

comment:22 Changed 4 years ago by chapoton

  • Description modified (diff)

comment:23 Changed 4 years ago by jmantysalo

  • Description modified (diff)

Frédéric, how we know when 6.10 is going out, i.e. when to close this?

comment:24 Changed 4 years ago by git

  • Commit changed from 5a6d106d6682d06bed98fc8399eb2da3bec7952e to c139ef9d5b66505559abc26c4d593510c96fdb0f

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

c139ef9trac #19354 doc in linear extensions

comment:25 Changed 4 years ago by chapoton

  • Description modified (diff)

comment:26 Changed 4 years ago by git

  • Commit changed from c139ef9d5b66505559abc26c4d593510c96fdb0f to 10df38bb8d50dceeb66ef88526fd614d53feb28c

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

10df38btrac #19354 links in coding in python

comment:27 Changed 4 years ago by chapoton

  • Description modified (diff)

Please correct the last topic, so that we can close this ticket now, and open a new one. No need to wait for 6.10.

comment:28 Changed 4 years ago by git

  • Commit changed from 10df38bb8d50dceeb66ef88526fd614d53feb28c to 9cb0d4045ff3c7b68732a20071bab6e7eb3148f7

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

9cb0d40Added an example of graphs() iterator.

comment:29 Changed 4 years ago by jmantysalo

  • Authors set to Frédéric Chapoton, Jori Mäntysalo
  • Description modified (diff)
  • Status changed from new to needs_review

As you wish. But I guess I won't review this until monday.

Example of graphs() is kind of artificial. But better examples take more time, and maybe are not better for showing how to use this.

comment:30 Changed 4 years ago by git

  • Commit changed from 9cb0d4045ff3c7b68732a20071bab6e7eb3148f7 to 7f996b441ed799572730a4b603c5a491d4939e2e

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

7f996b4trac #19354 new style doc-test continuation please

comment:31 Changed 4 years ago by chapoton

ok, looks good to me now. Jori, please double check and set to positive review if you agree

comment:32 follow-up: Changed 4 years ago by jmantysalo

  • Status changed from needs_review to needs_work
  • A 3-tuple (`g`, ``rw``, ``signs``) misses a pair of ` around g.
  • is_directed_acyclic on digraph.py, still too much indentation on output, see part "When certificate=True".

Otherwise I found no problems.

comment:33 in reply to: ↑ 32 ; follow-up: Changed 4 years ago by chapoton

Replying to jmantysalo:

  • A 3-tuple (`g`, ``rw``, ``signs``) misses a pair of ` around g.

No, this is written `g` in the whole doc of the function, let us rather keep that.

  • is_directed_acyclic on digraph.py, still too much indentation on output, see part "When certificate=True".

I do not understand. How much indentation do you want ? 0 ?

comment:34 in reply to: ↑ 33 Changed 4 years ago by jmantysalo

Replying to chapoton:

  • A 3-tuple (`g`, ``rw``, ``signs``) misses a pair of ` around g.

No, this is written `g` in the whole doc of the function, let us rather keep that.

OK.

  • is_directed_acyclic on digraph.py, still too much indentation on output, see part "When certificate=True".

I do not understand. How much indentation do you want ? 0 ?

There is

        * When ``certificate=True``:

            * If the graph is acyclic, returns a pair ``(True, ordering)``
              where ``ordering`` is a list of the vertices such that ``u``
              appears before ``v`` in ``ordering`` if ``u, v`` is an edge.

and I think that it should be

        * When ``certificate=True``:

          * If the graph is acyclic, returns a pair ``(True, ordering)``
            where ``ordering`` is a list of the vertices such that ``u``
            appears before ``v`` in ``ordering`` if ``u, v`` is an edge.

I.e. 2 spaces less, and so one level less in indentation.

comment:35 Changed 4 years ago by git

  • Commit changed from 7f996b441ed799572730a4b603c5a491d4939e2e to 9807c4a5990b8c06ac88708bec14107d86db2b94

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

9807c4atrac #19354 shift by 2 instead of 4

comment:36 Changed 4 years ago by jmantysalo

  • Status changed from needs_work to positive_review

No more complains.

comment:37 Changed 4 years ago by jmantysalo

  • Reviewers set to Jori Mäntysalo, Frédéric Chapoton

Almost forgot. I put Frédéric also as reviewer, as he read my example on graphs() iterator.

comment:38 Changed 4 years ago by vbraun

  • Status changed from positive_review to needs_work

Merge conflict, try again with the next beta

comment:39 Changed 4 years ago by git

  • Commit changed from 9807c4a5990b8c06ac88708bec14107d86db2b94 to 9185acb5a14a539051b615d8526303e6cdeff499

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

9185acbMerge branch 'minor_typos' into minor_typos_6_9

comment:40 Changed 4 years ago by jmantysalo

  • Status changed from needs_work to needs_review

On is_directed_acyclic() at digraph.py I changed "When certificate=True :" to "When certificate=True:", i.e. removed a space. Now this merges.

comment:41 Changed 4 years ago by chapoton

  • Status changed from needs_review to positive_review

comment:42 Changed 4 years ago by vbraun

  • Branch changed from public/19354 to 9185acb5a14a539051b615d8526303e6cdeff499
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.