Ticket #41 (new enhancement)

Opened 17 months ago

Last modified 4 months ago

Provide return value policy in doc strings

Reported by: artem Owned by: artemp
Priority: major Milestone: 1.0.0
Component: Boost.Python Binding Version: SVN Trunk
Severity: Normal Keywords: find_style
Cc: Patch Needs Improvement:
Needs Docmentation: Has Patch?:
Design Decision Needed:

Description

Some methods e.g: 

style = m.find_style('My Style')

returns a copy of an object while others might reference existing object. We need to provide doc strings to clearly state 'return value policy'

Change History

Changed 11 months ago by artem

  • milestone changed from 0.5.0 to 1.0.0

Changed 4 months ago by springmeyer

  • priority set to major

Can you start a wiki page with hints on how to best add docstrings to the bindings? I bet that many users could help with basic patches to get this and other basic docstring going.

Note: See TracTickets for help on using tickets.