Opened 6 years ago

Closed 6 years ago

#13715 closed defect (fixed)

documentation for "attach" should mention load_attach_path()

Reported by: ddrake Owned by: mvngu
Priority: minor Milestone: sage-5.9
Component: documentation Keywords: load attach path
Cc: Merged in: sage-5.9.beta5
Authors: Dan Drake Reviewers: David Roe, Travis Scrimshaw
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description (last modified by roed)

The documentation for attach doesn't say anything about load_attach_path, so if you try to attach a file and Sage complains, it's hard to figure out how to fix it. The docstring for attach should mention load_attach_path().

Related: #378.

Apply

Attachments (4)

trac13715.patch (9.2 KB) - added by jdemeyer 6 years ago.
trac_13715-review-ts.patch (11.2 KB) - added by tscrim 6 years ago.
trac13715.2.patch (8.1 KB) - added by ddrake 6 years ago.
rebased for 5.9.beta0
trac_13715-review-ts.2.patch (12.5 KB) - added by ddrake 6 years ago.

Download all attachments as: .zip

Change History (21)

comment:1 Changed 6 years ago by ddrake

  • Authors set to Dan Drake
  • Status changed from new to needs_review

comment:2 Changed 6 years ago by ddrake

The patch adds session.pyx to the documentation so that the docstring for attach appears in the HTML version. I rearranged the docstring for attach, added links, improved formatting, and removed some trailing whitespace. I also added links and removed trailing whitespace in preparser.py.

comment:3 Changed 6 years ago by roed

  • Status changed from needs_review to positive_review

Looks good to me.

comment:4 follow-up: Changed 6 years ago by tscrim

  • Status changed from positive_review to needs_work

This needs a proper commit message. Please put your real name as a reviewer. Thanks.

comment:5 Changed 6 years ago by roed

  • Reviewers set to David Roe

comment:6 in reply to: ↑ 4 Changed 6 years ago by ddrake

  • Status changed from needs_work to positive_review

Replying to tscrim:

This needs a proper commit message.

Oops. Fixed.

comment:7 Changed 6 years ago by jdemeyer

  • Milestone changed from sage-5.5 to sage-5.6

Changed 6 years ago by jdemeyer

comment:8 Changed 6 years ago by jdemeyer

Rebased to sage-5.5.rc0.

comment:9 Changed 6 years ago by jdemeyer

  • Status changed from positive_review to needs_work

There are some Sphinx errors:

docstring of sage.misc.session:12: WARNING: Block quote ends without a blank line; unexpected unindent.
docstring of sage.misc.session:14: WARNING: Definition list ends without a blank line; unexpected unindent.
docstring of sage.misc.session:11: ERROR: Unexpected indentation.

comment:10 Changed 6 years ago by jdemeyer

* ping *

Changed 6 years ago by tscrim

comment:11 Changed 6 years ago by tscrim

  • Status changed from needs_work to needs_review

These errors were caused from session.pyx being imported into the manual (and not by the patch itself). I've attached a reviewer patch which cleans up the rest of the documentation in the file.

Changed 6 years ago by ddrake

rebased for 5.9.beta0

comment:12 Changed 6 years ago by ddrake

The patches here bitrotted, so I rebased them for 5.9.beta0 and uploaded attachment:trac13715.2.patch and attachment:trac_13715-review-ts.2.patch (I can't overwrite the original patches).

comment:13 Changed 6 years ago by roed

For patchbot: apply trac13715.2.patch trac_13715-review-ts.2.patch

comment:14 Changed 6 years ago by roed

  • Description modified (diff)

Changed 6 years ago by ddrake

comment:15 Changed 6 years ago by ddrake

Oops, my rebase had some bad Sphinx markup. Fixed now.

comment:16 Changed 6 years ago by tscrim

  • Reviewers changed from David Roe to David Roe, Travis Scrimshaw
  • Status changed from needs_review to positive_review

Looks good to me. Thanks.

comment:17 Changed 6 years ago by jdemeyer

  • Merged in set to sage-5.9.beta5
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.