Skip to content

improve the documentation of the action#23

Merged
keewis merged 8 commits intoscientific-python:mainfrom
keewis:examples
Sep 14, 2023
Merged

improve the documentation of the action#23
keewis merged 8 commits intoscientific-python:mainfrom
keewis:examples

Conversation

@keewis
Copy link
Copy Markdown
Contributor

@keewis keewis commented Sep 13, 2023

So far the documentation was pretty minimal: a simple example, no explanation of the options, no real-world examples.

@keewis
Copy link
Copy Markdown
Contributor Author

keewis commented Sep 13, 2023

cc @jrbourbeau, I hope you don't mind me using dask as an example

Copy link
Copy Markdown
Contributor

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem at all! Only suggestion would be to point to an already closed issue : )

@jrbourbeau
Copy link
Copy Markdown
Contributor

Btw, I wrote a short blogpost about how we're using this over in the Dask / Coiled blogs that give you a shoutout https://blog.dask.org/2023/04/18/dask-upstream-testing. I can't remember if I sent you this already or not -- hope that's okay

Co-authored-by: James Bourbeau <jrbourbeau@users.noreply.github.com>
@keewis
Copy link
Copy Markdown
Contributor Author

keewis commented Sep 14, 2023

I don't remember whether you pinged me regarding that, but I do remember reading that blog post and being happy that the action is useful for other people. In other words, yes, that's totally okay!

@keewis keewis merged commit 7035600 into scientific-python:main Sep 14, 2023
@keewis keewis deleted the examples branch September 14, 2023 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link to example issues from readme ?

2 participants