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

Improve the docs #28

Closed
gandad opened this issue Mar 9, 2020 · 7 comments
Closed

Improve the docs #28

gandad opened this issue Mar 9, 2020 · 7 comments

Comments

@gandad
Copy link

gandad commented Mar 9, 2020

Excellent work! I love this tool very much.
I think you can improve the docs.
I tried some times to know how to use AdHocStage to do sum/mean operations.
The description of AggByCols is worse.

Please provide some basic information about your system (Python version,
operating system, &c).

@marctorsoc
Copy link

marctorsoc commented Apr 17, 2020

related to this, I think a great and easy improvement would be to have links to each of the pipes here https://pdpipe.github.io/pdpipe/doc/pdpipe/#basic-stages

also being this my first comment, wanna take this msg to show appreciation for this very nice work. I hope they integrate this into pandas at some point

@yarkhinephyo
Copy link
Contributor

Hi! I can try to add the suggestions above to the documentation

@shaypal5
Copy link
Collaborator

Have a go at it!

You can look at the tests for the aforementioned stages for help on other uses for them.

Also ask me for help if you need it.

And please - any use case you add documentation for, add a basic test for in the test suites of the corresponding stage; whatever we publish the package can do, we MUST test for.

Good luck! :)

@shaypal5
Copy link
Collaborator

See PR #65 .

yarkhinephyo added a commit to yarkhinephyo/pdpipe that referenced this issue Nov 18, 2021
Improve basic_stages docs

Fix minor mistake in basic_stages

Rename label to single label

Improve col_generation docs

Improve cond docs

Improve core docs

Improve cq docs

Undo minor docstring change in col-generation

Fix pr comments

Improve text_stages docs

Improve wrappers docs

Improve sklearn_stages doc

Improve skintegrate docs

Improve nltk_stages documentation

Improve documentation.md by adding links
shaypal5 pushed a commit that referenced this issue Nov 18, 2021
Improve basic_stages docs

Fix minor mistake in basic_stages

Rename label to single label

Improve col_generation docs

Improve cond docs

Improve core docs

Improve cq docs

Undo minor docstring change in col-generation

Fix pr comments

Improve text_stages docs

Improve wrappers docs

Improve sklearn_stages doc

Improve skintegrate docs

Improve nltk_stages documentation

Improve documentation.md by adding links
shaypal5 pushed a commit that referenced this issue Nov 18, 2021
Improve basic_stages docs

Fix minor mistake in basic_stages

Rename label to single label

Improve col_generation docs

Improve cond docs

Improve core docs

Improve cq docs

Undo minor docstring change in col-generation

Fix pr comments

Improve text_stages docs

Improve wrappers docs

Improve sklearn_stages doc

Improve skintegrate docs

Improve nltk_stages documentation

Improve documentation.md by adding links
shaypal5 pushed a commit that referenced this issue Nov 18, 2021
Improve basic_stages docs

Fix minor mistake in basic_stages

Rename label to single label

Improve col_generation docs

Improve cond docs

Improve core docs

Improve cq docs

Undo minor docstring change in col-generation

Fix pr comments

Improve text_stages docs

Improve wrappers docs

Improve sklearn_stages doc

Improve skintegrate docs

Improve nltk_stages documentation

Improve documentation.md by adding links
shaypal5 pushed a commit that referenced this issue Nov 18, 2021
Improve basic_stages docs

Fix minor mistake in basic_stages

Rename label to single label

Improve col_generation docs

Improve cond docs

Improve core docs

Improve cq docs

Undo minor docstring change in col-generation

Fix pr comments

Improve text_stages docs

Improve wrappers docs

Improve sklearn_stages doc

Improve skintegrate docs

Improve nltk_stages documentation

Improve documentation.md by adding links
@shaypal5
Copy link
Collaborator

shaypal5 commented Feb 4, 2022

I think the new doc site is a step in the right direction! :)
https://pdpipe.readthedocs.io/en/latest/

When enough of the how-tos written as answered to issues raised here, or as part of notebooks, are on it as tutorials, I'll deem this a closed issue.

@shaypal5
Copy link
Collaborator

shaypal5 commented Feb 4, 2022

Btw @yarkhinephyo , that's another way for you to add docs to the package. :)

@shaypal5
Copy link
Collaborator

Closing this as the doc site now includes a fair amount of nice tutorials.

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

No branches or pull requests

4 participants