Opened 9 years ago

Closed 8 years ago

#11462 closed enhancement (fixed)

Improve @parallel documentation to give examples of functions with multiple arguments

Reported by: niles Owned by: mvngu
Priority: major Milestone: sage-5.0
Component: documentation Keywords: @parallel documentation beginner sd35.5
Cc: kcrisman Merged in: sage-5.0.beta1
Authors: Nathan Carter Reviewers: Karl-Dieter Crisman
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

All of the examples for @parallel (even those mentioned on mailing lists) demonstrate using it with functions that take a single argument. Figuring out the syntax for multiple-argument functions can be slightly non-obvious, so the documentation should be improved.

More details at this asksage question.

Attachments (1)

trac-11462-parallel-documentation.patch (1.4 KB) - added by ncarter 8 years ago.

Download all attachments as: .zip

Change History (9)

comment:1 Changed 9 years ago by niles

  • Type changed from PLEASE CHANGE to defect

comment:2 Changed 8 years ago by ncarter

  • Status changed from new to needs_review

Will post in a moment a patch that does what this ticket asks...

comment:3 Changed 8 years ago by ncarter

  • Keywords sd35.5 added

Changed 8 years ago by ncarter

comment:4 Changed 8 years ago by ncarter

Updated patch to ensure doctests succeed.

comment:5 Changed 8 years ago by kcrisman

  • Authors set to Nathan Carter
  • Reviewers set to Karl-Dieter Crisman
  • Status changed from needs_review to positive_review

Good work, looks good in the manual, all is correct and passes tests. Positive review.

comment:6 Changed 8 years ago by jdemeyer

  • Milestone changed from sage-4.8 to sage-5.0
  • Type changed from defect to enhancement
  • Work issues improve documentation deleted

comment:7 Changed 8 years ago by kcrisman

See also #11461.

comment:8 Changed 8 years ago by jdemeyer

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