8000 Document the C/C++ code guidelines by mdboom · Pull Request #1606 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Document the C/C++ code guidelines #1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2013
Merged

Document the C/C++ code guidelines #1606

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions doc/devel/coding_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,25 @@ Installation
ones, make sure the new files included in the match patterns in
:file:`MANIFEST.in`, and/or in `package_data` in `setup.py`.

C/C++ extensions
----------------

* Extensions may be written in C or C++.

* Code style should conform to PEP7 (understanding that PEP7 doesn't
address C++, but most of its admonitions still apply).

* Interfacing with Python may be done either with the raw Python/C API
or Cython. Use of PyCXX is discouraged for new code.

* Python/C interface code should be kept separate from the core C/C++
code. The interface code should be named `FOO_wrap.cpp`.

* Header file documentation (aka docstrings) should be in Numpydoc
format. We don't plan on using automated tools for these
docstrings, and the Numpydoc format is well understood in the
scientific Python community.

Style guide
===========

Expand Down
0