Issue #26 resolved

PyObjC decorators are not covered by docs

Kentzo avatarKentzo created an issue

Decorators provided by PyObjC are not documented anywhere.

If you'd supply me with full list of decorators designed to be used in user code, I'd help with it.

Comments (6)

  1. Ronald Oussoren

    There is documentation in pyobjc-core/Doc/lib/module-objc.rst in the repository. That should document all decorators, although I haven't verified yet that everything is document.

    The decorators aren't grouped into one section though.

  2. Kentzo

    There is no pyobjc-core/Doc/lib/module-objc.rst, only pyobjc /pyobjc-core/Doc/api/module-objc.rst and it doesn't contain info about callbackFor

  3. Ronald Oussoren

    http://packages.python.org/pyobjc/api/module-objc.html?highlight=callbackfor#objc.callbackFor

    I recently renamed 'lib' to 'api', but forget about this in my previous message. Most functions should now be mentioned in the documentation, although some entries are currently placeholders.

    One big file is probably not the best way to document the module, and I've already pulled parts of it out (see for example the metadata subdirectory in the repository that documents the metadata system and all API related to that).

  4. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.