#13 Docs: owned/unowned references.

open-accepted
None
5
2005-08-29
2005-06-01
Anonymous
No

Hi,

Don't know if it's just me being thick, but I'd love to
see the docs changed from talking about 'owned' and
'unowned' references to talking about 'new' and
'borrowed' references.

Not only would this make things more consistent with
the Python API documentation, but also more explicit.
When I read the explanation that something returned an
'owned' reference I thought 'well, of course it's owned
by *someone*', but it wasn't clear whether it was owned
by the caller or callee. Only after looking up the
docs for PyString_FromString() was I able to figure out
the section on Class Object.

Discussion

  • Barry Alan Scott

    • status: open --> open-accepted
     
  • Barry Alan Scott

    Logged In: YES
    user_id=28665

    I need to do a lot of work on the docs. I'll review this naming.

     
  • Barry Alan Scott

    • assigned_to: nobody --> barry-scott
     

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks