Minor typos in 6.8 #19023

jm58660 · 2015-08-13T12:40:30Z

This is a container ticket for minor documentation typos found in version 6.8. 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.

generic_graph.py / breadth_first_search / :meth:successors broken link. Same with depth first.
generic_graph.py / is_planar, broken link to sage.graphs.planarity
To posets/init.html add links also to finite categories of posets and lattices.
posets.py, relabel(), wrong indentation after INPUT section.
Group theory tutorial, list of small groups, two }

Component: documentation

Author: Nathann Cohen, Frédéric Chapoton, Jori Mäntysalo

Branch/Commit: 712ebe8

Reviewer: Jori Mäntysalo, Nathann Cohen

Issue created by migration from https://trac.sagemath.org/ticket/19023

The text was updated successfully, but these errors were encountered:

nathanncohen · 2015-08-14T08:19:56Z

Commit: 8ce7f02

nathanncohen · 2015-08-14T08:19:56Z

Branch: u/ncohen/19023

nathanncohen · 2015-08-14T08:19:56Z

comment:3

Hellooooooooo !

I fixed some of the points you listed here, and so I add the commit. To be honest I am a bit scared to add a commit on a ticket that is not in needs_review, for I am worried that it may get forgotten... Saw this happen too many times already :-/

Nathann

New commits:

`8ce7f02`	`trac #19023: Broken graph/ links`

fchapoton · 2015-08-22T08:58:14Z

Changed commit from 8ce7f02 to f6a4371

fchapoton · 2015-08-22T08:58:14Z

Changed branch from u/ncohen/19023 to public/ticket/19023

fchapoton · 2015-08-22T08:58:14Z

comment:7

I took care of the typos in the group theory tuto and posets. Maybe we can just stop there for the moment ?

New commits:

`5dc1443`	`Merge branch 'u/ncohen/19023' into 6.9.b3`
`f6a4371`	`trac #19023 typos in group tuto, posets and digraph`

jm58660 · 2015-08-24T07:02:42Z

comment:8

Replying to @fchapoton:

I took care of the typos in the group theory tuto and posets. Maybe we can just stop there for the moment ?

But then we should just open a new one... And I guess 6.9 will not be out for some time.

I did this because a) Nathann hoped for less tickets, at least tickets only correcting a typo or two, b) Sage seems to still have small typos that I found when reading the manuals, and c) for me it seems unlogical to correct totally non-relating typo in some ticket.

As an artifical example: Let's suppose that I wonder about Frattini sublattice. When thinking about docstring I see a typo in Frattini subgroup. Now I should make a note about the typo, so that I won't forget it when I make a patch at last.

sagetrac-git · 2015-09-07T07:53:57Z

Changed commit from f6a4371 to f43f9c4

sagetrac-git · 2015-09-07T07:53:57Z

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

`f43f9c4`	`Added links to categories of finite posets and lattices.`

jm58660 · 2015-09-07T08:17:49Z

comment:10

I look throught your pathces. Two questions:

Why is interior_paths removed from index?
What is meant by "(see GenericGraph and GenericGraph)" on documentation of option force_spring_layout?

Otherwise all seems good. As beta5 is already out, maybe we should close this and start collecting typos for 6.10. Please also review my small patch that add two links.

jm58660 · 2015-09-07T08:17:49Z

Reviewer: Jori Mäntysalo

jm58660 · 2015-09-07T08:17:49Z

Changed author from Jori Mäntysalo to Nathann Cohen, Frédéric Chapoton, Jori Mäntysalo

nathanncohen · 2015-09-07T08:40:46Z

comment:11

Yo,

Why is interior_paths removed from index?

Because the function does not exist anymore (#17462)

What is meant by "(see GenericGraph and GenericGraph)" on documentation of option force_spring_layout?

Odd. Well, I guess it was meant to be references toward .show and .plot.

Nathann

nathanncohen · 2015-09-07T08:42:27Z

comment:12

Please also review my small patch that add two links.

To me FinitePosets and FiniteLatticePosets are internal classes, and not meant to be instanciated by the user.

Nathann

jm58660 · 2015-09-07T09:34:05Z

comment:13

Replying to @nathanncohen:

To me FinitePosets and FiniteLatticePosets are internal classes, and not meant to be instanciated by the user.

Arghs. As #18534 got rejected, now there is no way for the user to found is_selfdual(). And are you sure that category of finite posets is meant to be internal? I know that the class is.

nathanncohen · 2015-09-07T09:57:02Z

comment:14

And are you sure that category of finite posets is meant to be internal? I know that the class is.

I do not think that the category of Posets is meant to be internal.

jm58660 · 2015-09-07T10:40:02Z

comment:15

Replying to @nathanncohen:

And are you sure that category of finite posets is meant to be internal? I know that the class is.

I do not think that the category of Posets is meant to be internal.

I guess you meant the category of finite posets. Then my patch should be OK (but needs review, of course). And now just force_spring_layout needs checking.

nathanncohen · 2015-09-07T10:42:52Z

comment:16

Oh, my mistake. I was thinking of the class FinitePoset (without the terminal 's'). No problem with your last commit.

jm58660 · 2015-09-07T18:13:41Z

comment:17

I will change some M\"obius to Möbius, so please wait a little more.

sagetrac-git · 2015-09-08T00:35:11Z

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

`d96eb1e`	`From M\"obius to Möbius.`

sagetrac-git · 2015-09-08T00:35:11Z

Changed commit from f43f9c4 to d96eb1e

sagetrac-git · 2015-09-08T00:52:53Z

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

`712ebe8`	`sage.graphs.graph_plot_js.gen_html_code, doc of force_spring_layout.`

sagetrac-git · 2015-09-08T00:52:53Z

Changed commit from d96eb1e to 712ebe8

jm58660 · 2015-09-08T00:54:29Z

comment:20

Replying to @nathanncohen:

What is meant by "(see GenericGraph and GenericGraph)" on documentation of option force_spring_layout?

Odd. Well, I guess it was meant to be references toward .show and .plot.

I removed those links. Ready for review.

nathanncohen · 2015-09-08T04:55:39Z

comment:21

Okay.

jm58660 · 2015-09-09T12:51:31Z

comment:22

Nathann, look at shard_preorder_graph() on catalog of posets and lattices. The link is broken.

nathanncohen · 2015-09-09T12:55:51Z

comment:23

On my machine it seems fine.

jm58660 · 2015-09-09T15:37:08Z

comment:24

Replying to @nathanncohen:

On my machine it seems fine.

Arghs. Partially built documentation. Sorry for noice.

jm58660 · 2015-09-11T06:29:41Z

comment:25

Beta6 was released, so maybe this one should be closed. Nathann is busy. Frédéric, can you check my changes: 1) "M"oibus" to "Möbius" is hasse_diagram.py, 2) two links added in posets/__init__.py and 3) removed links in graph_plot_js.py? After these this can be set to postive review, as I already check changes made by you and Nathann.

nathanncohen · 2015-09-11T06:41:56Z

comment:26

There is no problem with those commits, consider them reviewed.

jm58660 · 2015-09-11T06:50:25Z

Changed reviewer from Jori Mäntysalo to Jori Mäntysalo, Nathann Cohen

jm58660 · 2015-09-11T06:50:25Z

comment:27

Replying to @nathanncohen:

There is no problem with those commits, consider them reviewed.

Then everything is reviewed. I added your name to reviewrs list. Thanks.

vbraun · 2015-09-11T16:47:04Z

Changed branch from public/ticket/19023 to 712ebe8

jm58660 mannequin added this to the sage-6.9 milestone Aug 13, 2015

jm58660 mannequin added c: documentation labels Aug 13, 2015

This comment has been minimized.

Sign in to view

nathanncohen mannequin added s: needs review and removed s: needs review labels Aug 14, 2015

This comment has been minimized.

Sign in to view

jm58660 mannequin added s: needs review and removed s: needs work labels Sep 7, 2015

jm58660 mannequin added s: needs work and removed s: needs review labels Sep 7, 2015

jm58660 mannequin added s: needs review and removed s: needs work labels Sep 8, 2015

jm58660 mannequin added s: positive review and removed s: needs review labels Sep 11, 2015

vbraun removed the s: positive review label Sep 11, 2015

vbraun closed this as completed in 2c6dc0b Sep 11, 2015

Minor typos in 6.8 #19023

Minor typos in 6.8 #19023

Comments

jm58660 mannequin commented Aug 13, 2015

This comment has been minimized.

This comment has been minimized.

nathanncohen mannequin commented Aug 14, 2015

nathanncohen mannequin commented Aug 14, 2015

nathanncohen mannequin commented Aug 14, 2015

This comment has been minimized.

This comment has been minimized.

fchapoton commented Aug 22, 2015

fchapoton commented Aug 22, 2015

fchapoton commented Aug 22, 2015

jm58660 mannequin commented Aug 24, 2015

sagetrac-git mannequin commented Sep 7, 2015

sagetrac-git mannequin commented Sep 7, 2015

jm58660 mannequin commented Sep 7, 2015

jm58660 mannequin commented Sep 7, 2015

jm58660 mannequin commented Sep 7, 2015

nathanncohen mannequin commented Sep 7, 2015

nathanncohen mannequin commented Sep 7, 2015

jm58660 mannequin commented Sep 7, 2015

nathanncohen mannequin commented Sep 7, 2015

jm58660 mannequin commented Sep 7, 2015

nathanncohen mannequin commented Sep 7, 2015

jm58660 mannequin commented Sep 7, 2015

sagetrac-git mannequin commented Sep 8, 2015

sagetrac-git mannequin commented Sep 8, 2015

sagetrac-git mannequin commented Sep 8, 2015

sagetrac-git mannequin commented Sep 8, 2015

jm58660 mannequin commented Sep 8, 2015

nathanncohen mannequin commented Sep 8, 2015

jm58660 mannequin commented Sep 9, 2015

nathanncohen mannequin commented Sep 9, 2015

jm58660 mannequin commented Sep 9, 2015

jm58660 mannequin commented Sep 11, 2015

nathanncohen mannequin commented Sep 11, 2015

jm58660 mannequin commented Sep 11, 2015

jm58660 mannequin commented Sep 11, 2015

vbraun commented Sep 11, 2015