[blivet/rhel7 1/4] Let setUpBootLoader raise BootloaderError (#1015277)

Brian C. Lane bcl at redhat.com
Mon Oct 7 16:49:19 UTC 2013


On Mon, Oct 07, 2013 at 10:01:21AM +0200, Vratislav Podzimek wrote:
> On Thu, 2013-10-03 at 16:38 -0700, Brian C. Lane wrote:
> > From: "Brian C. Lane" <bcl at redhat.com>
> > 
> > This allows callers to deal with bootloader errors.
> > 
> > Related: rhbz#1015277
> > ---
> >  blivet/__init__.py | 10 +++++-----
> >  1 file changed, 5 insertions(+), 5 deletions(-)
> > 
> > diff --git a/blivet/__init__.py b/blivet/__init__.py
> > index d15a0d0..083ce78 100644
> > --- a/blivet/__init__.py
> > +++ b/blivet/__init__.py
> > @@ -1702,7 +1702,10 @@ class Blivet(object):
> >          self.bootloader.set_disk_list(boot_disks)
> >  
> >      def setUpBootLoader(self):
> > -        """ Propagate ksdata into BootLoader. """
> > +        """ Propagate ksdata into BootLoader.
> > +
> > +            :raises: BootloaderError if stage1 setup fails
> > +        """
> I think that exceptions should be documented as:
> :raises EXCEPTION: CONDITION
> 
> with the colon after the exception type. Or at least that makes sense to
> me in context of the 'param' and 'type' fields.

Ah, ok. And if we have multiple exceptions then a :raise ...:
description for each one of them would be the right way. Looks like this
is lightly documented here:

http://sphinx-doc.org/markup/desc.html#info-field-lists

And contradicted, or maybe just a variation because of the namespace use
here:

http://rest-sphinx-memo.readthedocs.org/en/latest/ReST.html#info-field-lists

I'll change it locally.

-- 
Brian C. Lane | Anaconda Team | IRC: bcl #anaconda | Port Orchard, WA (PST8PDT)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 482 bytes
Desc: not available
URL: <https://lists.fedorahosted.org/pipermail/anaconda-patches/attachments/20131007/2b7d9ee7/attachment.sig>


More information about the anaconda-patches mailing list