Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for word (over str vs over integer) #10261

Closed
seblabbe opened this issue Nov 14, 2010 · 12 comments
Closed

Improve documentation for word (over str vs over integer) #10261

seblabbe opened this issue Nov 14, 2010 · 12 comments

Comments

@seblabbe
Copy link
Contributor

As noticed by Florent Hivert here, the following two objects :

sage: w = Word('010120')
sage: z = Word([0, 1, 0, 1, 2, 0])

have the same string representation :

sage: w
word: 010120
sage: z
word: 010120

but are not equal :

sage: w == z
False

Indeed, w and z are defined on different alphabet :

sage: w[2]
'0'
sage: z[2]
0

Documentation about this should be improved.

Also that url looks very bad:
http://doc.sagemath.org/html/en/reference/combinat/sage/combinat/words/__init__.html

which is referenced from
http://doc.sagemath.org/html/en/reference/combinat/index.html

CC: @sagetrac-tmonteil

Component: documentation

Keywords: sd75

Author: Sébastien Labbé

Branch/Commit: 97dada0

Reviewer: Thierry Monteil

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

@seblabbe seblabbe added this to the sage-5.11 milestone Nov 14, 2010
@seblabbe seblabbe self-assigned this Nov 14, 2010
@jdemeyer jdemeyer modified the milestones: sage-5.11, sage-5.12 Aug 13, 2013
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.1, sage-6.2 Jan 30, 2014
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.2, sage-6.3 May 6, 2014
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.3, sage-6.4 Aug 10, 2014
@seblabbe

This comment has been minimized.

@seblabbe
Copy link
Contributor Author

Changed keywords from none to sd75

@seblabbe
Copy link
Contributor Author

comment:6

I am cleaning my old trac tickets during Sage Days 75.

@seblabbe
Copy link
Contributor Author

Branch: u/slabbe/10261

@seblabbe
Copy link
Contributor Author

New commits:

fe28a5510261: cleaning documentation of main page of combinat/words in reference manual
4c5e50910261: documenting ambiguous representation of words

@seblabbe
Copy link
Contributor Author

Commit: 4c5e509

@seblabbe
Copy link
Contributor Author

Author: Sébastien Labbé

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 26, 2016

Changed commit from 4c5e509 to 97dada0

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 26, 2016

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

68d1a0310261: cleaning documentation of main page of combinat/words in reference manual
97dada010261: documenting ambiguous representation of words

@sagetrac-tmonteil
Copy link
Mannequin

sagetrac-tmonteil mannequin commented Aug 26, 2016

Reviewer: Thierry Monteil

@sagetrac-tmonteil
Copy link
Mannequin

sagetrac-tmonteil mannequin commented Aug 26, 2016

comment:9

Through this way of indexing the contents of the doc via __init__.py files is specific to the combinat section (which leads to weird URLs), the commits fix the issue and the doc is improved.

@vbraun
Copy link
Member

vbraun commented Aug 29, 2016

Changed branch from u/slabbe/10261 to 97dada0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants