missing pointer in documentation

[zimmerma]

The documentation from RealIntervalField says:

       See the documentation for ``RealIntervalField_class`` for many more
       examples.

However there is no documentation for RealIntervalField_class:

sage: RealIntervalField_class?
Object `RealIntervalField_class` not found.

[kcrisman]

Current code is actually

    See the documentation for :class:`RealIntervalField_class` for many more
    examples.

So this would just have to add a little so that users at the command line could see where to find this; in the documentation it would still look the same and have the right link.

[zimmerma]

Karl-Dieter,
do you know how to find the documentation from the command line?

sage: :class:RealIntervalField_class?
Object `:class:RealIntervalField_class` not found.

Paul

[kcrisman]

Yes, and I thought one of my students had made a patch for this. It turns out to live in sage.rings.real_mpfi.RealIntervalField_class?

[kcrisman]

I see what you were asking now in comment:3. Most Sage documentation now has these hyperlinks, but it does mean one has to ignore the backticks and things like :class or :meth:. I think this is standard now.

sage.rings.real_mpfi.RealIntervalField_class?

is the correct command, and the patch coming up changes the doc so that this can at least be found, modulo the extra formatting.

[kcrisman]

Based on Sage 5.1.beta0

[kini]

Other than the fact that you have created an excessively long line in the docstring, this ticket looks good to go.

[kini]

apply to $SAGE_ROOT/devel/sage

[kini]

Here's a reviewer patch to fix the "excessively long line", per your suggestion :)

[kini]

patchbot, please, please, please apply trac_9260.patch trac_9260.reviewer.patch (pretty please)

[jdemeyer]

Please fill in your real name in the Author / Reviewer fields.

[kini]

Done.

[kcrisman]

Hmm, that is a good change in the reviewer patch - I wasn't aware that syntax was an option.

Jeroen, I think you know who kini is - wouldn't that have taken fewer characters? ;-)

[kini]

Jeroen is correct in asking me to add my name. Ideally a release manager should need to do as little work as possible - and what work he does do should be limited to administrative oversight. The more automation we can add to the system of getting Sage releases out, the better.

[kcrisman]

I agree that you (or I) should have done it! I was just pointing out that in this particular case it actually took him more effort than doing it himself - hence the winky emoticon. Presumably this will save him effort in the long run, though, I agree.

[kini]

Well, since he left exactly the same message on two other tickets which I had forgotten to put my name on, there's a strong possibility that he had scripted it :) And that's a good thing!