Ticket #2030 (closed defect: fixed)

Opened 1 year ago

Last modified 1 month ago

[with patch, positive review] hg_[doc|extcode|scripts] docstring is wrong about the repo

Reported by: mabshoff Assigned to: mhansen
Priority: major Milestone: sage-3.2.2
Component: documentation Keywords:
Cc:

Description 

[05:58] <mabshoff> The docstring for hg_scripts also seems to be wrong, i.e.
[05:58] <mabshoff>         Most commands are directly provided as member functions.  However,
[05:58] <mabshoff>         you can use the full functionality of hg, i.e.,
[05:58] <mabshoff>                 hg_sage("command line arguments")
[05:58] <mabshoff>         is *exactly* the same as typing
[05:58] <mabshoff>                 cd <SAGE_ROOT>/devel/sage/ && hg command line arguments
[05:59] <mabshoff> Same for hg_extcode and hg_doc

Attachments

trac_2030.patch (2.3 kB) - added by mhansen on 12/01/2008 11:56:52 PM.

Change History

02/01/2008 10:26:57 PM changed by was 

22:24 < wstein> #2030 - what's wrong with the hg docstrig?
22:25 < wstein> I couldn't figure that out from the ticket desc.
22:25 < mabshoff> All of them say to cd into $SAGE_LOCAL/deve/sage
22:25 < mabshoff> while the repos are in different places.
22:25 < wstein> I think it's a "generic" docstring.
22:25 < wstein> All the hg_* objects are instances of a generic hg object.
22:25 < mabshoff> Ok, so is it fixable? Or is it invalid?
22:26 < wstein> It should be fixed.
22:26 < wstein> It might be kind of hard / unnatural.
22:26 < wstein> However, if it is really confusing it should be changed.
22:26 < mabshoff> Well, we could list all four repos in the generic docstring.
22:26 < wstein> Or at least the docstring could be made much clearer to emphasize this subtle point.
22:26 < wstein> Exactly

09/19/2008 12:31:16 AM changed by mhansen

  • owner changed from tba to mhansen.
  • status changed from new to assigned.

12/01/2008 11:56:52 PM changed by mhansen

  • attachment trac_2030.patch added.

12/01/2008 11:58:33 PM changed by mhansen

  • summary changed from hg_[doc|extcode|scripts] docstring is wrong about the repo to [with patch, needs review] hg_[doc|extcode|scripts] docstring is wrong about the repo.

12/03/2008 03:32:21 AM changed by mabshoff

Hmmm, the second patch seems to be the same as the first one, but I would guess you accidentally did not post the second one.

Thoughts?

Cheers,

Michael

12/06/2008 02:36:19 PM changed by was

  • summary changed from [with patch, needs review] hg_[doc|extcode|scripts] docstring is wrong about the repo to [with patch, positive review] hg_[doc|extcode|scripts] docstring is wrong about the repo.

Patch looks good (and is fun/clever). Maybe Mike just hit submit twice by accident.

12/08/2008 03:20:30 AM changed by mabshoff

  • status changed from assigned to closed.
  • resolution set to fixed.

Merged in Sage 3.2.2.alpha1