Skip to content

docstring documentation for python-bindings#33

Merged
BenjaminRodenberg merged 9 commits intodevelopfrom
newDocumentation
Feb 7, 2020
Merged

docstring documentation for python-bindings#33
BenjaminRodenberg merged 9 commits intodevelopfrom
newDocumentation

Conversation

@IshaanDesai
Copy link
Member

Closes #3

@BenjaminRodenberg BenjaminRodenberg changed the title WIP: Documentation for python-bindings WIP: docstring documentation for python-bindings Feb 6, 2020
@IshaanDesai IshaanDesai changed the title WIP: docstring documentation for python-bindings docstring documentation for python-bindings Feb 6, 2020
@IshaanDesai IshaanDesai self-assigned this Feb 6, 2020
@IshaanDesai IshaanDesai added the documentation Improvements or additions to documentation label Feb 6, 2020
Copy link
Member

@BenjaminRodenberg BenjaminRodenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we do not need the doxygen_config file.

Additionally, it is important that we show how the datastructures in the python interface work. There are some important differences to the C++ API (e.g. pointers vs. numpy arrays) that should be reflected in the docstrings.

Copy link
Member

@BenjaminRodenberg BenjaminRodenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to stick to the numpy style docstrings (see here), if there are no reasons speaking against this.

Unfortunately, this seems to include a lot of manual work, since most python linters seem to have problems with cython code (I tried to use pylint with precice.pyx and you are just getting too many syntax errors).

Copy link
Member

@BenjaminRodenberg BenjaminRodenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found one typo. Rest looks absolutely great 👍

@BenjaminRodenberg BenjaminRodenberg merged commit de49cca into develop Feb 7, 2020
@IshaanDesai IshaanDesai deleted the newDocumentation branch February 13, 2020 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proper documentation for new python bindings

2 participants