Peter M. Groen / openbr

Commit b475ebe8b4ac7722b74281e9f90acfcefe58f437

Authored by Austin Blanton
1 parent 26f89097

Document how some python wrapper funcs differ from C API

Inline Side-by-side
Showing 1 changed file with 8 additions and 0 deletions
docs/docs/api_docs/python_api.md
  View file @b475ebe
... ... @@ -46,6 +46,14 @@ The Python API is a light wrapper of the C API. It creates an object that has [a
46 46 br.br_free_template_list(query)
47 47 br.br_finalize()
48 48  
  49 +Some functions were made more pythonic and thus differ slightly from the C API. In particular, the C functions that populate a string buffer have that logic abstracted away. For example, `br_get_filename(char * buffer, int buffer_length, br_template tmpl)` in C becomes `filename = br.br_get_filename(tmpl)` in Python. Here are the functions that differ from the C API:
  50 +
  51 +- br_most_recent_message
  52 +- br_objects
  53 +- br_scratch_path
  54 +- br_get_filename
  55 +- br_get_metadata_string
  56 +
49 57 To enable the module, add `-DBR_INSTALL_BRPY=ON` to your cmake command (or use the ccmake GUI - highly recommended).
50 58  
51 59 Currently only OS X and Linux are supported.
... ...