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

Standardize library documentation #296

Open
2 tasks
alejandrosame opened this issue Sep 13, 2020 · 2 comments
Open
2 tasks

Standardize library documentation #296

alejandrosame opened this issue Sep 13, 2020 · 2 comments
Labels
Status: Blocked ✖️ Cannot work on this because of some other incomplete work Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Milestone
Repository improv...

Comments

@alejandrosame
Copy link
Member

Where?

Python docstrings and PyDP official documentation.

Who?

Intended audience is PyDP users.

What?

  • Unify documentation style.
  • Provide clear documentation guidelines for contributors

Additional Context
@alejandrosame alejandrosame added the Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase label Sep 13, 2020
@alejandrosame alejandrosame added this to the Repository improvements milestone Sep 13, 2020
@alejandrosame alejandrosame mentioned this issue Sep 13, 2020
Open
@chinmayshah99
Copy link
Member

Following #252 (comment) should do the trick.

@chinmayshah99 chinmayshah99 added Status: Available 👋 Available for assignment, who wants it? Status: Blocked ✖️ Cannot work on this because of some other incomplete work and removed Status: Available 👋 Available for assignment, who wants it? labels Sep 14, 2020
@chinmayshah99
Copy link
Member

Documentation style is compiled by @shaistha24.
Once we have that ready, this should be available for grab.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Status: Blocked ✖️ Cannot work on this because of some other incomplete work Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Milestone
Repository improvements
Development

No branches or pull requests
2 participants
@alejandrosame @chinmayshah99