Opened 4 years ago

Closed 4 years ago

#19400 closed enhancement (fixed)

move documentation of asymptotic expansion to sage.asymptotic

Reported by: dkrenn Owned by:
Priority: major Milestone: sage-6.10
Component: asymptotic expansions Keywords:
Cc: behackl, cheuberg Merged in:
Authors: Daniel Krenn Reviewers: Clemens Heuberger
Report Upstream: N/A Work issues:
Branch: 55ea3a9 (Commits) Commit: 55ea3a90e5c57e818c1dfd0132f094e158110ff8
Dependencies: #19083 Stopgaps:

Description (last modified by dkrenn)

Move documentation from sage/rings/asymptotic to sage/asymptotic

Change History (11)

comment:1 Changed 4 years ago by dkrenn

  • Dependencies set to #19083

comment:2 in reply to: ↑ description ; follow-up: Changed 4 years ago by jdemeyer

Replying to dkrenn:

Move code from sage.rings.asymptotic to sage.asymptotic

Why?

comment:3 in reply to: ↑ 2 ; follow-up: Changed 4 years ago by dkrenn

Replying to jdemeyer:

Replying to dkrenn:

Move code from sage.rings.asymptotic to sage.asymptotic

Why?

  • For this asymptotic expansion project we had to create a separate asymptotic_expansion_index.rst in src/doc/en/reference/rings, which seems a bit unnatural. Including it also was not easily possible. Thus having it in sage.asymptotic will create less unnatural constructions and seems to be more like it should be.
  • Also the structure of the reference manual supports this choice: In its main index there is a section on standard rings and fields (sage.rings). The asymptotic expansions definitly do not belong there. The best fit (and a good one as well) is the main calculus section of the reference manual, where it now (since #19083) is.
  • #18528 will live in sage.manifolds as well. There are already projects directly in sage.*, e.g. quivers, quadratic forms, ...
  • The asymptotic expansion project not only consist of the AsymptoticRing (public), but there are term monoids and growth groups (but both more private than the ring) as well.

All in all sage.asymptotic seems to be the right choice.

comment:4 in reply to: ↑ 3 ; follow-up: Changed 4 years ago by jdemeyer

Replying to dkrenn:

  • For this asymptotic expansion project we had to create a separate asymptotic_expansion_index.rst in src/doc/en/reference/rings, which seems a bit unnatural.

Why unnatural? We have a separate index in the manual about finite rings for example, but I don't think we should have sage.finite_rings.

  • Also the structure of the reference manual supports this choice: In its main index there is a section on standard rings and fields (sage.rings). The asymptotic expansions definitly do not belong there. The best fit (and a good one as well) is the main calculus section of the reference manual, where it now (since #19083) is.

So you should move to sage.calculus.asymptotic or sage.symbolic.asymptotic then...

  • #18528 will live in sage.manifolds as well. There are already projects directly in sage.*, e.g. quivers, quadratic forms, ...

Are those things rings? A manifold and a quadratic form certainly is not a ring, I don't know about quivers.

Asymptotic expansions might not form a ring in the mathematical sense, but it is sufficiently ring-like (just like the symbolic "ring") that it can remain in sage.rings.

  • The asymptotic expansion project not only consist of the AsymptoticRing (public), but there are term monoids and growth groups (but both more private than the ring) as well.

How is this relevant?

I think that asymptotic expansions fit nicely next to polynomials for example in sage.rings. I just don't want to end up with 100 subdirectories directly in src/sage.

Anyway, I don't want to bikeshed too much over this, I'm not going to actively prevent anybody from moving this to sage.asymptotic. Just don't expect me to review this ticket :-)

comment:5 Changed 4 years ago by dkrenn

  • Branch set to u/dkrenn/asy/move-doc

comment:6 Changed 4 years ago by dkrenn

  • Commit set to a98af135a51d9e35e24ff2c8adcee5f52c99608b
  • Description modified (diff)
  • Summary changed from move code of asymptotic expansion module to sage.asymptotic to move documentation of asymptotic expansion to sage.asymptotic

New commits:

286801fmove asymptotic expansion index to sage/asymptotic
8f72fdaadd conf.py
a98af13update links to asymptotic module

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

  • Status changed from new to needs_review

Replying to jdemeyer:

Replying to dkrenn:

  • For this asymptotic expansion project we had to create a separate asymptotic_expansion_index.rst in src/doc/en/reference/rings, which seems a bit unnatural.

Why unnatural? We have a separate index in the manual about finite rings for example, but I don't think we should have sage.finite_rings.

Oh yes, I see; thanks for pointing this out. I will just do it as it is for the finite rings and only move the documentation.

comment:8 Changed 4 years ago by cheuberg

  • Branch changed from u/dkrenn/asy/move-doc to u/cheuberg/asy/move-doc

comment:9 Changed 4 years ago by cheuberg

  • Authors set to Daniel Krenn
  • Commit changed from a98af135a51d9e35e24ff2c8adcee5f52c99608b to 55ea3a90e5c57e818c1dfd0132f094e158110ff8
  • Reviewers set to Clemens Heuberger

I added a commit related to documentation which was lost during work on #19399.

Apart from that: documentation builds and works as expected. Thus from my side, this is a positive review. I'll set this to positive review in a few days if there are no objections by anybody else.


New commits:

997380bTrac #19399: Insert ReSt links
55ea3a9Trac #19400: Merge commit '997380baa67cc3d7fda5e9791c29d58f3ff15515' from #19399

comment:10 Changed 4 years ago by cheuberg

  • Status changed from needs_review to positive_review

comment:11 Changed 4 years ago by vbraun

  • Branch changed from u/cheuberg/asy/move-doc to 55ea3a90e5c57e818c1dfd0132f094e158110ff8
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.