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

Add SageNB modules to the reference manual #7367

Closed
qed777 mannequin opened this issue Nov 1, 2009 · 12 comments
Closed

Add SageNB modules to the reference manual #7367

qed777 mannequin opened this issue Nov 1, 2009 · 12 comments

Comments

@qed777
Copy link
Mannequin

qed777 mannequin commented Nov 1, 2009

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.

CC: @TimDumol

Component: doctest coverage

Author: Mitesh Patel

Reviewer: William Stein

Merged: sage-4.2.1.rc0

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

@qed777 qed777 mannequin added t: tests labels Nov 1, 2009
@qed777
Copy link
Mannequin Author

qed777 mannequin commented Nov 1, 2009

Attachment: trac_7367-sagenb_manual.patch.gz

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

@qed777
Copy link
Mannequin Author

qed777 mannequin commented Nov 1, 2009

comment:1

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

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

@qed777
Copy link
Mannequin Author

qed777 mannequin commented Nov 1, 2009

comment:2

Replying to @qed777:

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.

@qed777 qed777 mannequin added the s: needs review label Nov 1, 2009
@TimDumol
Copy link
Mannequin

TimDumol mannequin commented Nov 3, 2009

comment:4

Replying to @qed777:

Replying to @qed777:

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 #7384

@TimDumol
Copy link
Mannequin

TimDumol mannequin commented Nov 3, 2009

comment:5

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.

@qed777
Copy link
Mannequin Author

qed777 mannequin commented Nov 4, 2009

comment:6

"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.

@qed777
Copy link
Mannequin Author

qed777 mannequin commented Nov 4, 2009

Attachment: trac_7367-sagenb_manual_v2.patch.gz

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

@qed777
Copy link
Mannequin Author

qed777 mannequin commented Nov 12, 2009

comment:7

Feel free to bump the milestone to 4.3.

@qed777

This comment has been minimized.

@qed777 qed777 mannequin added this to the sage-4.2.1 milestone Nov 12, 2009
@williamstein
Copy link
Contributor

comment:8

Looks good to me too.

@mwhansen
Copy link
Contributor

Merged: sage-4.2.1.rc0

@mwhansen
Copy link
Contributor

Reviewer: William Stein

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

2 participants