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

Documentation #131

Open
6 of 11 tasks
pablomm opened this issue Jul 1, 2019 · 0 comments
Open
6 of 11 tasks

Documentation #131

pablomm opened this issue Jul 1, 2019 · 0 comments
Labels
documentation

Comments

@pablomm
Copy link
Member

pablomm commented Jul 1, 2019 •
edited by vnmabus
Loading

I open this issue to unify all pending tasks (in my opinion) with respect to documentation.

  • Write readme
  • Write index page in readthedocs, linking to the different modules and to the github repository
  • Provide a project description in pypi
  • Make missing examples listed in Missing examples #117
  • Fix pdf documentation (Error compiling pdf docs #70)
  • Show documentation of methods (Class documentation should show methods #91)
  • Make explicit imports in doctests
  • Remove __author__ and __email__ variables in modules
  • Update skfda/__init__.py docstring, shown when doing import skfda; help(skfda)
  • Write docstring of top level modules (e.g. help(skfda.preprocessing))
  • Integrate PEP 257 checker (?)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pablomm