Bug 409839 – Remove awkward/incorrect pydoc from portage.util.grabdict

• Status: RESOLVED FIXED
• Product: Portage Development

[Description Greg Turner 2012-03-27 09:27:38 UTC]

The pydoc states the line syntax is key: [list of values] but, if anything, the line syntax is key [list of values].  Either way, the preceding example is clear and this is confusing, so just drop it imo.

By the way, is '@returns' correct?  I see a lot of '@returns' in portage (and a lot of '@return') but pydoc.py doesn't say anything about 'returns'...?

Reproducible: Always

Actual Results:  
clarity

Expected Results:  
confusion

see attached

[Comment 1 Greg Turner 2012-03-27 09:27:57 UTC]

Created attachment 306827 [details, diff]
Remove confusing pydoc line

[Comment 2 Zac Medico 2012-03-27 15:49:59 UTC]

This is in git:

http://git.overlays.gentoo.org/gitweb/?p=proj/portage.git;a=commit;h=ae8070542fcee0516fbfa270f6ef3f3e53a8d220

(In reply to comment #0)
> By the way, is '@returns' correct?  I see a lot of '@returns' in portage
> (and a lot of '@return') but pydoc.py doesn't say anything about
> 'returns'...?

It should be '@return'.

[Comment 3 Zac Medico 2012-03-27 15:54:41 UTC]

(In reply to comment #2)
> (In reply to comment #0)
> > By the way, is '@returns' correct?  I see a lot of '@returns' in portage
> > (and a lot of '@return') but pydoc.py doesn't say anything about
> > 'returns'...?
> 
> It should be '@return'.

Fixed now:

http://git.overlays.gentoo.org/gitweb/?p=proj/portage.git;a=commit;h=b2147b15e11b3d30d646098696ef69d749aeb5b2

[Comment 4 Zac Medico 2012-03-28 01:17:35 UTC]

This is fixed in 2.1.10.52 and 2.2.0_alpha96.