Skip to content
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

Jump to bottom

Provide documentation #10

Open
abukaj opened this issue Jul 30, 2019 · 1 comment
Open

Provide documentation #10

abukaj opened this issue Jul 30, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@abukaj
Copy link
Member

abukaj commented Jul 30, 2019 •
edited
Loading

Documentation is supposed to be based on Sphinx reST and auto-generated from docstrings.
@abukaj abukaj added the enhancement New feature or request label Jul 30, 2019
abukaj added a commit that referenced this issue Jul 30, 2019
@abukaj
A stub of documentation provided
c8a0475 
Stubs of docstrings provided for two crucial methods of
`FunctionalKernelFieldReconstructor`: `__init__()` and `__call__()`.

This is the first attempt to address #10.
@abukaj
Copy link
Member Author

abukaj commented Jul 30, 2019

Docstrings provided by c8a0475 are quite crude and require refinement.
@m-kowalska Any ideas of possible improvements?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@abukaj