ascii_art in Tableaux.global_options has outdated documentation

sagemath / sage

Main repository of SageMath

https://www.sagemath.org

Other

1.28k stars 438 forks source link

ascii_art in Tableaux.global_options has outdated documentation #17995

Open b1da87f3-e506-4c3b-95bc-e2360e109e07 opened 9 years ago

b1da87f3-e506-4c3b-95bc-e2360e109e07 commented 9 years ago

In Tableaux.global_options, the ascii_art documentation is out of date: "normal" is no longer an option. The "table" option could possibly use a new alias.

CC: @opechenik @darijgr

Component: combinatorics

Keywords: days64, tableau

Author: Maria Monks Gillespie, Oliver Pechenik

Branch/Commit: public/17995 @ ddb4c16

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

b1da87f3-e506-4c3b-95bc-e2360e109e07 commented 9 years ago

Branch: u/MariaMonks/ascii_art_take2

b1da87f3-e506-4c3b-95bc-e2360e109e07 commented 9 years ago

Commit: cd5068d

b1da87f3-e506-4c3b-95bc-e2360e109e07 commented 9 years ago

New commits:

`21922fd`	`testing word wrapping`
`cd5068d`	`new ascii_art options`

b1da87f3-e506-4c3b-95bc-e2360e109e07 commented 9 years ago

Author: Maria Monks Gillespie, Oliver Pechenik

b1da87f3-e506-4c3b-95bc-e2360e109e07 commented 9 years ago

Changed keywords from none to days64, tableau

darijgr commented 9 years ago

comment:5

Good work! I have posted the underlying bug in the doctest framework as #18051.

darijgr commented 9 years ago

New commits:

`4cea527`	`Merge branch 'u/MariaMonks/ascii_art_take2' of git://trac.sagemath.org/sage into hu`
`ddb4c16`	`better keep around old doctests too`

darijgr commented 9 years ago

Changed branch from u/MariaMonks/ascii_art_take2 to public/17995

darijgr commented 9 years ago

Changed commit from cd5068d to ddb4c16

tscrim commented 9 years ago

comment:7

First, Darij, reviewer name.

Second, you should set .boxes as an alias for table and plain for diagram by adding alias=dict(plain='diagram', boxes="table"), see the options above the ascii_art for instance. This way you need far less code for the same effect you're trying to achieve (and it's easier to maintain).

Unfortunately, due to the current limitations of the doctesting framework, it doesn't know to run those tests in (dynamically) generated doc. See #14272. Also you'll have to update doctest/sources.py and it has a test to catch exactly how many tests we are currently skipping.

darijgr commented 9 years ago

comment:8

Thank you for the info! This is far down my queue, though, so I think my reviewer name has no business being there.

darijgr commented 9 years ago

comment:9

todo: ascii art should also take into account that tableaux can have huge entries