Juan Benavente Ponce added the comment: Comparing the docstrings with the on-line documentation, I have found that, in addition to the already mentioned issue, the fact that many methods only require the first argument to be a set (or frozenset) object is not mentioned anywhere in the docstrings. Would it be useful if I write here a list of all the cases where this happens, and a possible alternative? An example:
Python 2.7 set.union current docstring: """Return the union of sets as a new set. (i.e. all elements that are in either set.)""" possible enhancement: """union(set1, *iterables) --> new set Return a new set with elements from set1 and all the iterables.""" Would it be a good idea to create a different docstring for the bound method? E.g: unbound version: """union(set1, *iterables) --> new set Return a new set with elements from set1 and all the iterables.""" bound version: """set1.union(*iterables) --> new set Return a new set with elements from set1 and all the iterables.""" If writing this list would be useful, please tell me so, and I will do it. Thanks for your time! ---------- _______________________________________ Python tracker <rep...@bugs.python.org> <http://bugs.python.org/issue7263> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
