sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.44k stars 480 forks source link

Improving documentation for triangular module morphisms #15380

Closed darijgr closed 10 years ago

darijgr commented 11 years ago

This is just something I wrote while learning how to use triangular module morphisms. Nothing really changed apart from some asserts replaced by ValueErrors (far from systematically...) and some unneeded declarations and imports removed; however, the doc is IMHO more readable now and the doctests cover some less-obvious cases.

CC: @tscrim @hivert

Component: categories

Keywords: modules, free modules, days54

Author: Darij Grinberg

Branch/Commit: public/ticket/15380new @ 5dd0324

Reviewer: Travis Scrimshaw

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

darijgr commented 11 years ago

Branch: public/ticket/15380

darijgr commented 11 years ago

New commits:

[3dccb89](https://github.com/sagemath/sagetrac-mirror/commit/3dccb89)clarification on combination of keywords
[63c904a](https://github.com/sagemath/sagetrac-mirror/commit/63c904a)also, pyflakes said these are useless
[b0d2568](https://github.com/sagemath/sagetrac-mirror/commit/b0d2568)improving the docstring for triangular module morphisms
[ea902f9](https://github.com/sagemath/sagetrac-mirror/commit/ea902f9)change to clumsy but nonambiguous wording
[8fb58f1](https://github.com/sagemath/sagetrac-mirror/commit/8fb58f1)Some docstring improvements in modules_with_basis.py
darijgr commented 11 years ago

Commit: 3dccb89

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

Changed commit from 3dccb89 to 91f8160

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

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

[91f8160](https://github.com/sagemath/sagetrac-mirror/commit/91f8160)More documentation fixes.
tscrim commented 11 years ago
comment:4

Hey Darij,

I pushed some more docfixes, so if you're happy with my changes, then it's a positive review.

Best,

Travis

tscrim commented 11 years ago

Reviewer: Travis Scrimshaw

tscrim commented 11 years ago

Changed keywords from modules, free modules to modules, free modules, days54

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

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

[10e471e](https://github.com/sagemath/sagetrac-mirror/commit/10e471e)more doc fixes
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

Changed commit from 91f8160 to 10e471e

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

Changed commit from 10e471e to e564054

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

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

[e564054](https://github.com/sagemath/sagetrac-mirror/commit/e564054)typo fixed
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

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

[1452ef9](https://github.com/sagemath/sagetrac-mirror/commit/1452ef9)more grammar fixed
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 11 years ago

Changed commit from e564054 to 1452ef9

vbraun commented 10 years ago
comment:12

Test failures:

sage -t --long src/sage/combinat/ncsym/dual.py  # 1 doctest failed
sage -t --long src/sage/combinat/sf/new_kschur.py  # 3 doctests failed
sage -t --long src/sage/combinat/sf/sf.py  # 2 doctests failed
sage -t --long src/sage/tests/book_schilling_zabrocki_kschur_primer.py  # 1 doctest failed
darijgr commented 10 years ago

Changed commit from 1452ef9 to d98d159

darijgr commented 10 years ago
comment:13

Thanks, Volker, for spotting these. They come from a ValueError text I "improved", but since it wasn't really an improvement, I've just retracted that. Could I ask you for a little favor? The last commit should be easy to review.

darijgr commented 10 years ago

Changed commit from d98d159 to 5dd0324

darijgr commented 10 years ago
comment:14

OOPS, that's not the commit I wanted to upload! Sorry!

One moment while I'm trying to push force...


New commits:

5dd0324reverting a change to a ValueError string because it gave a more readable output; a couple more doc changes
darijgr commented 10 years ago
comment:15

OK, so let's do it manually. 5dd0324 is the correct HEAD, but https://github.com/sagemath/sagetrac-mirror/commits/public%2Fticket%2F15380&qt=range&q=develop..public%2Fticket%2F15380 will show the old branch which I accidentally uploaded. Sorry guys.

EDIT: unfortunately, clicking on the "branch" field also gives the crap branch instead of the right one. I'm going to do a manual override and change the "Branch" field...

EDIT2: Here, the new branch at least is correct. Sorry for the mess!!

darijgr commented 10 years ago

Changed branch from public/ticket/15380 to public/ticket/15380new

tscrim commented 10 years ago
comment:18

Sorry I didn't catch that Volker.

darijgr commented 10 years ago
comment:19

Thanks again, Travis!