Opened 4 years ago

Closed 4 years ago

#19023 closed defect (fixed)

Minor typos in 6.8

Reported by: jmantysalo Owned by:
Priority: trivial Milestone: sage-6.9
Component: documentation Keywords:
Cc: Merged in:
Authors: Nathann Cohen, Frédéric Chapoton, Jori Mäntysalo Reviewers: Jori Mäntysalo, Nathann Cohen
Report Upstream: N/A Work issues:
Branch: 712ebe8 (Commits) Commit: 712ebe89cda1b0e0804a680aac62db60acf9ef7b
Dependencies: Stopgaps:

Description (last modified by jmantysalo)

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 }

Change History (28)

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 ncohen

  • Branch set to u/ncohen/19023
  • Commit set to 8ce7f026975f1de95042018eca907553c55964a9
  • Status changed from new to needs_review

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:

8ce7f02trac #19023: Broken graph/ links

comment:4 Changed 4 years ago by ncohen

  • Status changed from needs_review to needs_work

comment:5 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:6 Changed 4 years ago by jmantysalo

  • Description modified (diff)

comment:7 follow-up: Changed 4 years ago by chapoton

  • Branch changed from u/ncohen/19023 to public/ticket/19023
  • Commit changed from 8ce7f026975f1de95042018eca907553c55964a9 to f6a4371c5134cca8dfcb324551d95b48f121a45d

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


New commits:

5dc1443Merge branch 'u/ncohen/19023' into 6.9.b3
f6a4371trac #19023 typos in group tuto, posets and digraph

comment:8 in reply to: ↑ 7 Changed 4 years ago by jmantysalo

Replying to chapoton:

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.

comment:9 Changed 4 years ago by git

  • Commit changed from f6a4371c5134cca8dfcb324551d95b48f121a45d to f43f9c4da4378b56cc0bc5e8cdc234754ceaebc1

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

f43f9c4Added links to categories of *finite* posets and lattices.

comment:10 follow-ups: Changed 4 years ago by jmantysalo

  • Authors changed from Jori Mäntysalo to Nathann Cohen, Frédéric Chapoton, Jori Mäntysalo
  • Reviewers set to Jori Mäntysalo
  • Status changed from needs_work to needs_review

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.

comment:11 in reply to: ↑ 10 ; follow-up: Changed 4 years ago by ncohen

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

comment:12 in reply to: ↑ 10 ; follow-up: Changed 4 years ago by ncohen

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

comment:13 in reply to: ↑ 12 ; follow-up: Changed 4 years ago by jmantysalo

Replying to ncohen:

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.

comment:14 in reply to: ↑ 13 ; follow-up: Changed 4 years ago by ncohen

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.

comment:15 in reply to: ↑ 14 Changed 4 years ago by jmantysalo

Replying to ncohen:

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.

comment:16 Changed 4 years ago by ncohen

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

comment:17 Changed 4 years ago by jmantysalo

  • Status changed from needs_review to needs_work

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

comment:18 Changed 4 years ago by git

  • Commit changed from f43f9c4da4378b56cc0bc5e8cdc234754ceaebc1 to d96eb1ed2c6f58d64f8fb98c4076dd04a686a900

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

d96eb1eFrom M\"obius to Möbius.

comment:19 Changed 4 years ago by git

  • Commit changed from d96eb1ed2c6f58d64f8fb98c4076dd04a686a900 to 712ebe89cda1b0e0804a680aac62db60acf9ef7b

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

712ebe8sage.graphs.graph_plot_js.gen_html_code, doc of force_spring_layout.

comment:20 in reply to: ↑ 11 Changed 4 years ago by jmantysalo

  • Status changed from needs_work to needs_review

Replying to ncohen:

  • 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.

comment:21 Changed 4 years ago by ncohen

Okay.

comment:22 Changed 4 years ago by jmantysalo

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

comment:23 follow-up: Changed 4 years ago by ncohen

On my machine it seems fine.

comment:24 in reply to: ↑ 23 Changed 4 years ago by jmantysalo

Replying to ncohen:

On my machine it seems fine.

Arghs. Partially built documentation. Sorry for noice.

comment:25 Changed 4 years ago by jmantysalo

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.

comment:26 follow-up: Changed 4 years ago by ncohen

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

comment:27 in reply to: ↑ 26 Changed 4 years ago by jmantysalo

  • Reviewers changed from Jori Mäntysalo to Jori Mäntysalo, Nathann Cohen
  • Status changed from needs_review to positive_review

Replying to ncohen:

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

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

comment:28 Changed 4 years ago by vbraun

  • Branch changed from public/ticket/19023 to 712ebe89cda1b0e0804a680aac62db60acf9ef7b
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.