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

Update pyKVFinderResults docstring and documentation #62

Merged
merged 1 commit into from
Sep 23, 2023

Conversation

jvsguerra
Copy link
Member

@jvsguerra jvsguerra commented Sep 23, 2023

This PR addresses the documentation inconsistencies reported in Issue #61. It focuses on updating the outdated code snippets found in the following locations:

>>> from pyKVFinder import pyKVFinder
>>> import os
>>> pdb = os.path.join(os.path.dirname(pyKVFinder.__file__), 'data', 'tests', '1FMO.pdb')
>>> results = pyKVFinder(pdb)
>>> results.export()

>>> from pyKVFinder import pyKVFinder
>>> import os
>>> pdb = os.path.join(os.path.dirname(pyKVFinder.__file__), 'data', 'tests', '1FMO.pdb')
>>> results = pyKVFinder(pdb)
>>> results.write()

>>> from pyKVFinder import pyKVFinder
>>> import os
>>> pdb = os.path.join(os.path.dirname(pyKVFinder.__file__), 'data', 'tests', '1FMO.pdb')
>>> results = pyKVFinder(pdb)
>>> results.plot_frequencies()

>>> from pyKVFinder import pyKVFinder
>>> import os
>>> pdb = os.path.join(os.path.dirname(pyKVFinder.__file__), 'data', 'tests', '1FMO.pdb')
>>> results = pyKVFinder(pdb)
>>> results.export_all()

These updates aim to improve the clarity and accuracy of the pyKVFinderResults documentation.

@jvsguerra jvsguerra added the documentation Improvements or additions to documentation label Sep 23, 2023
@jvsguerra jvsguerra merged commit bb63990 into LBC-LNBio:master Sep 23, 2023
6 checks passed
@jvsguerra jvsguerra linked an issue Sep 23, 2023 that may be closed by this pull request
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.

[Bug]: help me understand use of pyKVFinder
1 participant