> Yes, but there are no links.  Or do you have them?

True, they are not links. It would be nice if they were, though
personally I like that what is printed is the actual module name that I
should type in followed by ? to see its doc. That's probably how I would
do it even if it was a link, and IMHO beats replacing the module name by
only a description text which is a link.

> (I admit, I made a mistake: the text is the same, contrary what I wrote. 
>  Although I'm not sure that showing just the docstring of the class is best 
> possible: I recently used automethod, and this documentation is not 
> shown...)

What do you mean? If you type e.g

sage: codes?

you'll get the doc for sage.coding.codes_catalog.py. The table there is
auto-generated.

Best,
Johan

'Martin R' via sage-devel writes:

> Yes, but there are no links.  Or do you have them?
>
> (I admit, I made a mistake: the text is the same, contrary what I wrote. 
>  Although I'm not sure that showing just the docstring of the class is best 
> possible: I recently used automethod, and this documentation is not 
> shown...)
>
> Martin
>
> Am Donnerstag, 20. Oktober 2016 11:55:16 UTC+2 schrieb Johan S. R. Nielsen:
>>
>> I don't understand -- aren't you getting the full documentation, as in 
>> this page: 
>>
>>
>> http://doc.sagemath.org/html/en/reference/combinat/sage/combinat/posets/__init__.html#sage-combinat-posets
>>  
>>
>> At least, on my machine it prints the exact same information. 
>>
>> Best, 
>> Johan 
>>
>> 'Martin R' via sage-devel writes: 
>>
>> > As you may know, using https://github.com/sagemath/sage-shell-mode, 
>> working 
>> > with sage in emacs is a very enjoyable pastime. 
>> > In particular, typing at the sage prompt 
>> > 
>> > sage: sage.combinat.posets? 
>> > 
>> > opens a new frame and displays the documentation of sage.combinat.posets 
>> > there.  However, to my dismay, some of the documentation does not appear 
>> > there.  I reproduced the output for you at the end of this post.  As 
>> > stakemori told me, this is exactly what you get when using sage in the 
>> > console. 
>> > 
>> > On sphinx' homepage I see that sphinx can produce texinfo, which should 
>> be 
>> > the native document format for emacs. 
>> > 
>> > I have three questions: 
>> > 
>> > 1) what is currently used to produce the text printed when typing 
>> "object?" 
>> > 2) where would I have to add texinfo as documentation output format? 
>> > 3) (that's a question for stakemori) could you use texinfo docum emacs? 
>> > 
>> > 
>> > Martin 
>> > 
>> > Type:            module 
>> > String form:     <module 'sage.combinat.posets' from 
>> > 
>> '/home/martin/sage-patchbot/local/lib/python2.7/site-packages/sage/combinat/posets/__init__.pyc'>
>>  
>>
>> > File:           
>> > 
>>  
>> ~/sage-patchbot/local/lib/python2.7/site-packages/sage/combinat/posets/__init__.py
>>  
>>
>> > Docstring:       
>> > Posets 
>> > 
>> > Common posets can be accessed through "posets.<tab>" and are listed in 
>> > the posets catalog: 
>> > 
>> > * *Catalog of posets* 
>> > 
>> > Poset-related classes: 
>> > 
>> > * *sage.combinat.posets.posets* 
>>
>>
>> -- 
>>


-- 

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to