Opened 12 years ago

Closed 12 years ago

#7367 closed defect (fixed)

Add SageNB modules to the reference manual

Reported by: mpatel Owned by: tbd
Priority: minor Milestone: sage-4.2.1
Component: doctest coverage Keywords:
Cc: timdumol Merged in: sage-4.2.1.rc0
Authors: Mitesh Patel Reviewers: William Stein
Report Upstream: Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by mpatel)

Currently, the reference manual's Notebook section documents the old Sage notebook.

We should update this section with docstrings from the recently separated SageNB.

See also: #7384.

Attachments (2)

trac_7367-sagenb_manual.patch (2.2 KB) - added by mpatel 12 years ago.
Add SageNB modules to reference manual. Apply to sage repo.
trac_7367-sagenb_manual_v2.patch (2.2 KB) - added by mpatel 12 years ago.
Less confusing subheading. Really skip interface modules. Apply only this patch to sage repo.

Download all attachments as: .zip

Change History (11)

Changed 12 years ago by mpatel

Add SageNB modules to reference manual. Apply to sage repo.

comment:1 follow-up: Changed 12 years ago by mpatel

I've commented out the "Interfaces" section, for now.

I think sagenb.misc.sphinxify's docstrings need just a bit of tweaking.

comment:2 in reply to: ↑ 1 ; follow-up: Changed 12 years ago by mpatel

Replying to mpatel:

I think sagenb.misc.sphinxify's docstrings need just a bit of tweaking.

Of course, we can comment it out, too, temporarily. I didn't mean to pile on more work.

comment:3 Changed 12 years ago by mpatel

  • Status changed from new to needs_review

comment:4 in reply to: ↑ 2 Changed 12 years ago by timdumol

Replying to mpatel:

Replying to mpatel:

I think sagenb.misc.sphinxify's docstrings need just a bit of tweaking.

Of course, we can comment it out, too, temporarily. I didn't mean to pile on more work.

Docstring fixes are up at http://trac.sagemath.org/sage_trac/ticket/7384

comment:5 Changed 12 years ago by timdumol

Everything looks good, but why is the miscellaneous section named "Documentation"? Shouldn't it be named "Miscellaneous functions", or "Introspection", or the like? The name "Documentation" is confusing, at least for me.

comment:6 Changed 12 years ago by mpatel

"Documentation" is indeed confusing. I think my motive was to identify and group the [mostly] help-related modules. Since support falls under "Online Help" and "Miscellaneous," the forthcoming patch simply puts them all under the latter.

Changed 12 years ago by mpatel

Less confusing subheading. Really skip interface modules. Apply only this patch to sage repo.

comment:7 Changed 12 years ago by mpatel

  • Description modified (diff)
  • Milestone set to sage-4.2.1

Feel free to bump the milestone to 4.3.

comment:8 Changed 12 years ago by was

  • Status changed from needs_review to positive_review

Looks good to me too.

comment:9 Changed 12 years ago by mhansen

  • Merged in set to sage-4.2.1.rc0
  • Resolution set to fixed
  • Reviewers set to William Stein
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.