[2/3 blivet] Add method to set the default disklabel (#1078537)

Anne Mulhern amulhern at redhat.com
Thu Jun 19 15:28:39 UTC 2014





----- Original Message -----
> From: "Brian C. Lane" <bcl at redhat.com>
> To: anaconda-patches at lists.fedorahosted.org
> Sent: Thursday, June 19, 2014 10:19:41 AM
> Subject: Re: [2/3 blivet] Add method to set the default disklabel (#1078537)
> 
> On Thu, Jun 19, 2014 at 09:05:53AM -0400, Anne Mulhern wrote:
> > > > > +           :param string disklabel: The disklabel type to set as
> > > > > default
> > > > 
> > > > If you use actual typename "str" above, you get a pretty little
> > > > hyperlink
> > > > in the
> > > > generated html documents and so forth as appropriate. For "string",
> > > > nothing
> > > > but plain old text.
> > > This sounds like a possible Sphinx RFE/bugreport to me.
> > > 
> > 
> > I realized there's an amusing problem.
> > 1) str is actually a type name, as <type 'str'> whereas string is not, but
> > 2) there is no documentation about the type to link to, so the link goes to
> > the str() function
> > This is how the Python library documentation behaves as well as our blivet
> > documentation.
> > 
> > This is probably why
> > 1) For :param you get the behavior I described
> > 2) For :rtype: str does not get a link
> 
> Ah, ok. That's why I was expecting it to just use whatever I threw in
> there. That's another good reason to use the param style then.
> 
> > 
> > The behavior is consistent for str, int, bool, all those builtin types.
> > 
> > But I still think we should use the actual type name in docs.
> > For forward compatibility considerations, in Python 3 docs,
> > there is a tiny entry for the str class, and the link makes more sense.
> > 
> > I've suggested to intersphinx that they put links in both :param and :rtype
> > positions for these builtin types.
> 
> I agree.
> 
> Will fix locally before pushing.
> 
> --
> Brian C. Lane | Anaconda Team | IRC: bcl #anaconda | Port Orchard, WA
> (PST8PDT)
> _______________________________________________
> anaconda-patches mailing list
> anaconda-patches at lists.fedorahosted.org
> https://lists.fedorahosted.org/mailman/listinfo/anaconda-patches
> 

Clarification:

It looks like it does put in the link for :type, just not for :rtype:.

- mulhern



More information about the anaconda-patches mailing list