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.

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

Misleading (outdated) docstrings #89

Open
abukaj opened this issue Mar 14, 2019 · 1 comment
Open

Misleading (outdated) docstrings #89

abukaj opened this issue Mar 14, 2019 · 1 comment

Comments

@abukaj
Copy link
Member

abukaj commented Mar 14, 2019

I think the docstrings should be inspected and updated.

For example docstring for KCSD.create_lookup() suggests it has a parameter dist_table_density (it has not; it is provided as attribute):

kCSD-python/kcsd/KCSD.py

Lines 131 to 141 in 2ce755a

def create_lookup(self):
"""Creates a table for easy potential estimation from CSD.
Updates and Returns the potentials due to a
given basis source like a lookup
table whose shape=(dist_table_density,)
Parameters
----------
dist_table_density : int
number of distance points at which potentials are computed.
Default 100
"""

It also claims dist_table_density defaults to 100 while in the constructor it defaults to 20:
self.dist_table_density = kwargs.pop('dist_table_density', 20)

@ccluri
Copy link
Collaborator

ccluri commented Apr 7, 2019

Thanks Kuba!

Perhaps I should also bump this pending issue #33

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants