Context Navigation

← Previous Ticket
Next Ticket →

#7534 closed enhancement (fixed)

Add a deprecation message at the top of most sage.server.* files

Reported by:	mpatel	Owned by:	boothby
Priority:	minor	Milestone:	sage-4.3
Component:	notebook	Keywords:
Cc:	timdumol, was	Merged in:	sage-4.3.rc1
Authors:	Tim Dumol	Reviewers:	Mike Hansen
Report Upstream:	N/A	Work issues:
Branch:		Commit:
Dependencies:		Stopgaps:

Status badges

Description

To avoid confusion, we should add a message to the top of each old Sage notebook .py file stating that one should work on SageNB instead.

This should be a patch to the core Sage library.

Attachments (2)

trac_7534-deprecation-message (51.1 KB) - added by timdumol 11 years ago.: Adds the recommended deprecation message (with typo correction)
trac_7534-deprecation-message_v2.patch (50.2 KB) - added by mpatel 11 years ago.: Adds nodoctest.py files. Replacement patch.

Download all attachments as: .zip

Change History (12)

comment:1 Changed 11 years ago by mpatel

Cc timdumol was added

How about

This file is part of the OLD Sage notebook and is NOT actively developed,
maintained, or supported.  As of Sage v4.1.2, all notebook development has
moved to the separate Sage Notebook project:

http://nb.sagemath.org/

The new notebook is installed in Sage as a spkg (e.g., sagenb-0.3.spkg).

Please visit the project's home page for more information, including directions on
obtaining the latest source code.  For notebook-related development and support,
please consult the sage-notebook discussion group:

http://groups.google.com/group/sage-notebook

comment:2 Changed 11 years ago by mpatel

See sage-notebook.

Changed 11 years ago by timdumol

Attachment trac_7534-deprecation-message added

Adds the recommended deprecation message (with typo correction)

comment:3 Changed 11 years ago by timdumol

Status changed from new to needs_review

This should do the job.

comment:4 Changed 11 years ago by mhansen

Authors set to Tim Dumol
Reviewers set to Mike Hansen
Status changed from needs_review to needs_work

This causes some failures in tests in sage/server/

comment:5 follow-up: ↓ 6 Changed 11 years ago by mhansen

{{{ sage -t devel/sage-main/sage/server/notebook/notebook_object.py # 4 doctests failed }}}

comment:6 in reply to: ↑ 5 Changed 11 years ago by was

Replying to mhansen:

{{{ sage -t devel/sage-main/sage/server/notebook/notebook_object.py # 4 doctests failed }}}

Since the code isn't being run and is officially "deprecated", one option is to put a nodoctest.py file in the directory (or #nodoctest at the top of the file) so that the code isn't tested.