Skip to content

Conversation

isabela-pf
Copy link
Owner

@isabela-pf isabela-pf commented Sep 28, 2021

Welcome!

This is the working PR for the PyLadies SWFL, PyLadies Miami, and Python SWFL alt text mini sprint (that's a lot of words)! This is where we collaborate during the event before we send a clean contribution over to the main repo.

How to contribute

For the full info about this event, please visit the HackMD agenda.

During the event, you can contribute alt text to any of the images on currently used in a blog post. Please contribute via suggestions so we can easily review each other's work.

If you plan to work on a file, let people know by commenting below. We can have multiple suggestions for the same alt text, but it would be nice if we spread out to cover more images.

If you think an image is missing from these files, let @isabela-pf know and she'll add it to the PR.

Images in this PR

To make collaborating easier, comment below with the number of the image you'd like to work on. You can do this as a group, and you can write alt text for as many images as you'd like.

File: doc/modules/biclustering.rst (Link to biclustering docs and rendered images)

File: doc/modules/calibration.rst (Link to the calibration docs and rendered images)

File: doc/modules/clustering.rst (Link to the clustering docs and rendered images)

File: doc/modules/covariance.rst (Link to the covariance docs and rendered images)


If you need anything, please ask @isabela-pf or @MarsBarLee! 🌻

@isabela-pf
Copy link
Owner Author

Here's a checklist of a few formatting factors you can check for when reviewing alt text:

The alt text has

  • Correct spelling and no typos
  • Periods and commas where relevant
  • No more than three short, complete sentences
  • A logical way of fitting in the rest of the documentation
  • Consistent text and/or descriptions for the same elements in different images
  • A description of any text in the image

@MarsBarLee
Copy link

MarsBarLee commented Sep 30, 2021

The link to my slides from earlier

Step by Step: How to Add Alt-text with Github Suggestions (example image below)
image

Co-authored-by: Reshama Shaikh <2507232+reshamas@users.noreply.github.com>
@isabela-pf
Copy link
Owner Author

Hey everyone! Just a reminder that I will close this PR soon to get it ready for submitting to the main repo. I'm planning to clean everything up and reply to the main issue in the next 24–48 hours, so it'd be best if you make any final submissions before then. I know I still want to write some 😆.

isabela-pf and others added 6 commits October 9, 2021 23:40
Co-authored-by: Reshama Shaikh <2507232+reshamas@users.noreply.github.com>
Co-authored-by: Madelene Campos <Madelene@users.noreply.github.com>
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
Co-authored-by: InessaPawson <albuscode@gmail.com>
Co-authored-by: sunsyray <33903999+sunsyray@users.noreply.github.com>
Co-authored-by: Agustina <pesce.agustina@gmail.com>
Co-authored-by: MarsBarLee <46167686+MarsBarLee@users.noreply.github.com>
Co-authored-by: Aerik Pawson <45904740+aerikpawson@users.noreply.github.com>
@isabela-pf
Copy link
Owner Author

Again, thank you to everyone who participated. I hope this was a good exercise for you (and maybe inspires you to write alt text on other projects)!

I'm closing this PR to open one on the proper scikit-learn repo and will link it here once the PR is up.

@isabela-pf isabela-pf closed this Oct 11, 2021
@isabela-pf
Copy link
Owner Author

It's PR time! Look at all you cool kids in the commit history! 🌻 scikit-learn#21354

Thanks again for taking the time to contribute.

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.

9 participants