Opened 12 years ago

Closed 12 years ago

#10641 closed defect (fixed)

fix documentation in sage.misc.package.install_all_optional_packages

Reported by: agiorgetti Owned by: mvngu
Priority: trivial Milestone: sage-4.6.2
Component: documentation Keywords: days28, beginner
Cc: tmonteil, agiorgetti, joudinet Merged in: sage-4.6.2.alpha3
Authors: Johan Oudinet Reviewers: Gagan Sekhon
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

In

sage.misc.package.install_all_optional_packages

the arguments (for instance force-bool, dry_run-bool), and True and False should be written in verbatim font.

Moreover, examples should be interpreted as such.

See

http://localhost:8000/doc/live/reference/sage/misc/package.html

Attachments (2)

trac_10641-Documentation_Fix-sg.patch (1.3 KB) - added by giraudo 12 years ago.
Tested on 4.6.1
trac_10641-fix-documentation-jo.patch (2.0 KB) - added by joudinet 12 years ago.
Add the extra 4 spaces needed in the note block.

Download all attachments as: .zip

Change History (17)

comment:1 Changed 12 years ago by joudinet

I'm trying to fix this bug, but I don't understand what you mean by "the arguments should be written in verbatim"?

comment:2 Changed 12 years ago by joudinet

  • Status changed from new to needs_info

comment:3 Changed 12 years ago by joudinet

  • Cc joudinet added

comment:4 follow-up: Changed 12 years ago by mvngu

  • Milestone set to sage-4.6.2

Replying to joudinet:

I'm trying to fix this bug, but I don't understand what you mean by "the arguments should be written in verbatim"?

An example is worth a thousand words. I encourage you to actually inspect the file

SAGE_ROOT/devel/sage-main/sage/misc/package.py

to understand how to properly format function arguments and examples. Use a pair of double back ticks to delimit a word or expression as verbatim, e.g.

This word is ``verbatim``.

See also examples in other source files in the Sage library for more formatting examples, e.g.

SAGE_ROOT/devel/sage-main/sage/misc/randstate.pyx

comment:5 in reply to: ↑ 4 Changed 12 years ago by joudinet

Replying to mvngu:

to understand how to properly format function arguments and examples. Use a pair of double back ticks to delimit a word or expression as verbatim, e.g.

This word is ``verbatim``.

See also examples in other source files in the Sage library for more formatting examples, e.g.

SAGE_ROOT/devel/sage-main/sage/misc/randstate.pyx

Ok. Thanks for your explanation. Now, I do understand that arguments should be formatted in verbatim.

Changed 12 years ago by giraudo

Tested on 4.6.1

comment:6 Changed 12 years ago by joudinet

  • Status changed from needs_info to needs_review

comment:7 Changed 12 years ago by gagansekhon

  • Reviewers set to Gagan Sekhon
  • Status changed from needs_review to positive_review

Passed test and html looks good.

comment:8 Changed 12 years ago by jdemeyer

  • Status changed from positive_review to needs_info

joudinet: please add your real name as Author and also add yourself to http://trac.sagemath.org/sage_trac/#AccountNamesmappedtoRealNames

comment:9 follow-up: Changed 12 years ago by joudinet

  • Authors set to Johan Oudinet

Done. Should I change the status to needs_review again?

comment:10 Changed 12 years ago by mvngu

  • Priority changed from minor to trivial
  • Status changed from needs_info to needs_review

comment:11 in reply to: ↑ 9 Changed 12 years ago by jdemeyer

  • Status changed from needs_review to positive_review

Replying to joudinet:

Done. Should I change the status to needs_review again?

In this case, you can even set back the status to positive_review.

comment:12 Changed 12 years ago by jdemeyer

  • Status changed from positive_review to needs_work

Please check Sphinx syntax:

/mnt/usb1/scratch/jdemeyer/merger/sage-4.6.2.alpha2/devel/sage/doc/en/reference/sage/misc/package.rst:: (ERROR/3) Content block expected for the "NOTE" directive; none found.

Changed 12 years ago by joudinet

Add the extra 4 spaces needed in the note block.

comment:13 Changed 12 years ago by joudinet

  • Status changed from needs_work to needs_review

Ok. I missed to add 4 extra spaces in the Note block. Sorry. This is now working.

comment:14 Changed 12 years ago by gagansekhon

  • Status changed from needs_review to positive_review

OK, so ran the tests again. And this time I made sure there were no errors. I checked on my laptop mac ox 10.6 64 bit and sage.math to be sure.

Sorry, I missed the error last time.

comment:15 Changed 12 years ago by jdemeyer

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