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

Better docstrings #268

Open
ODiogoSilva opened this issue May 29, 2017 · 2 comments
Open

Better docstrings #268

ODiogoSilva opened this issue May 29, 2017 · 2 comments
Labels
enhancement

Comments

@ODiogoSilva
Copy link
Owner

Compliant with PEP257 (https://www.python.org/dev/peps/pep-0257/)
@ODiogoSilva
Copy link
Owner Author

And the numpy guidelines (https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#sections)

@ODiogoSilva
Copy link
Owner Author

ODiogoSilva commented May 29, 2017 •
edited
Loading

Objects that will receive the updated docstrings:

  • app
  • orthomcl_pipeline
  • data
    • resources
      • background_tasks
      • custom_widgets
  • base
    • plotter
  • ortho
    • OrthomclToolbox
  • process
    • module info
    • base
    • data
    • sequence

ODiogoSilva added a commit that referenced this issue May 29, 2017
@ODiogoSilva
Closes #267. Contributes to #268
5151920
ODiogoSilva added a commit that referenced this issue May 29, 2017
@ODiogoSilva
Finished base docstrings. #268
b15771c
ODiogoSilva added a commit that referenced this issue May 31, 2017
@ODiogoSilva
Improved docstrings for sequence #268
22d1ec7
ODiogoSilva added a commit that referenced this issue May 31, 2017
@ODiogoSilva
Added more docstrings #268
b36b0f5
@ODiogoSilva ODiogoSilva mentioned this issue May 31, 2017
Closed
ODiogoSilva added a commit that referenced this issue Jun 1, 2017
@ODiogoSilva
Finished process Alignment docstrings. Refactores write_to_file. #268
ecb5bc3
@ODiogoSilva ODiogoSilva added this to the 0.6 milestone Jun 1, 2017
ODiogoSilva added a commit that referenced this issue Jun 1, 2017
@ODiogoSilva
Added doc for AlignmentList #268
334e0c8
ODiogoSilva added a commit that referenced this issue Jun 2, 2017
@ODiogoSilva
Finished docstrings for sequence module #268
a7c38e1
ODiogoSilva added a commit that referenced this issue Jun 5, 2017
@ODiogoSilva
Finished sequence docstrings. Fixed tests and refactoring consequences.
f085b02 
#268
ODiogoSilva added a commit that referenced this issue Jun 5, 2017
@ODiogoSilva
Finished docstrings for process.data #268
6bed796
ODiogoSilva added a commit that referenced this issue Jun 5, 2017
@ODiogoSilva
Finished docstrings for base.plotter #268
dd821a1
ODiogoSilva added a commit that referenced this issue Jun 5, 2017
@ODiogoSilva
Added sequence module docstrings #268
8be6f53
ODiogoSilva added a commit that referenced this issue Jun 6, 2017
@ODiogoSilva
Docstring galore #268
92d38c9
ODiogoSilva added a commit that referenced this issue Jun 6, 2017
@ODiogoSilva
Added trifusion package docstring. Added links. #268
126a9ee
ODiogoSilva added a commit that referenced this issue Jun 7, 2017
@ODiogoSilva
Added more docstrings #268
3ae3990
ODiogoSilva added a commit that referenced this issue Jun 7, 2017
@ODiogoSilva
Added module list to data subpackage #268
c7fc6c0
ODiogoSilva added a commit that referenced this issue Jun 7, 2017
@ODiogoSilva
Added docstrings to background_tasks #268
e246fd9
ODiogoSilva added a commit that referenced this issue Jun 7, 2017
@ODiogoSilva
Improved package docstring. #268
78cd126
ODiogoSilva added a commit that referenced this issue Jun 7, 2017
@ODiogoSilva
Started app docstrings #268
f0e3c86
ODiogoSilva added a commit that referenced this issue Jun 7, 2017
@ODiogoSilva
Change method nomenclature guide position #268
5d39f83
@ODiogoSilva ODiogoSilva removed this from the 0.6 milestone Dec 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ODiogoSilva