Skip to content

blog post: pyOpenSci at PyCon #385

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

Merged
merged 13 commits into from
May 15, 2024
Merged

blog post: pyOpenSci at PyCon #385

merged 13 commits into from
May 15, 2024

Conversation

kierisi
Copy link
Contributor

@kierisi kierisi commented May 15, 2024

This is a first pass at the pyOS guide to PyCon post. I figured it would be better to have our current list up and posted, and then we can add to it as we get more information.

htmlproofer is failing due to the blog post link not existing yet, but otherwise everything should be ready for review!


@kierisi kierisi requested a review from lwasser as a code owner May 15, 2024 03:14
@kierisi
Copy link
Contributor Author

kierisi commented May 15, 2024

@lwasser I'm stuck on a codespell error that I have no idea how to fix. in the packaging summit, I have "Mr. Batchelder" because codespell won't let me use Ned's name (it wants me to use Need). is there a way to go about making a commit, even if codespell is unhappy?

@lwasser
Copy link
Member

lwasser commented May 15, 2024

@lwasser I'm stuck on a codespell error that I have no idea how to fix. in the packaging summit, I have "Mr. Batchelder" because codespell won't let me use Ned's name (it wants me to use Need). is there a way to go about making a commit, even if codespell is unhappy?

ahhhhh great question. i thought we had a ignore words file but apparently we don't!

i think we should follow the instructions here

https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file

i'd copy what is setup in our packaging guide:

  1. create a pyproject.toml file
  2. add a section like below to it.
  3. create a text file - codespell-ignore.txt (what you name it is less important that it being properly spelled in the toml file!
  4. add ned's name and any other names that you want to the ignore file so it doesn't do that again!
[tool.codespell]
ignore-words = "codespell-ignore.txt"
skip = "./.git,./.nox,./_static,./_build,codespell-ignore.txt,*.svg"

let me know how this goes!!

also - if you are ever super annoyed / stuck and want to push exactly the text that you need in the blog post and don't know how to fix it locally - you can use:

git commit -m "message here" --no-verify

no verify as a flag will skip pre commit hooks altogether so you can atleast make the changes that you want and then ask in the pr or on slack or wherever it makes the most sense to ask - why is it blocking me from doing x.

### <i class="fa-solid fa-users-between-lines"></i> 10:00--3:15 PM: Documentation Summit
The [Documentation Summit](https://us.pycon.org/2024/events/hatchery/docs-summit/) will be a full-day summit including talks and panel sessions inviting leaders in documentation to share their experience in how to make good documentation, discussion about documentation tools such as sphinx, mkdocs, themes etc, what are the common mistakes and how to avoid them.

And at 1:00 PM you can catch [Carol Willing](https://github.com/willingc) and [Mr. Batchelder](https://github.com/nedbat) giving an update from the Python Docs Editorial Board!
Copy link
Member

Choose a reason for hiding this comment

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

pre-commit can be so tricky. i'd just fix this locally and use --no-verify to get it online! then you can add the codespell ignore stuff either in this PR or in a separate one. whatever you prefer :) but let's call Ned - Ned.

this reminds me of when i read the times or WSJ - they always refer to people like mr musk and it always makes me chuckle. i don't know why however . 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes! it's so formal, and it seems even doubly so because it's in the middle of a blog post where everyone else is referred to by their first name.

lwasser
lwasser previously approved these changes May 15, 2024
Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

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

This is great @kierisi - please merge when you're ready!

comments: true
---
## <i class="fa-solid fa-heart"></i> Connect with the pyOpenSci community at PyCon US 2024!
We know there are a million things to do and see while at [PyCon US 2024](https://us.pycon.org/2024/) in beautiful Pittsburgh this weekend, so we wanted to compile a list of every talk, keynote, summit, and panel where you can expect to meet some of the fantastic pyOpenSci community members!
Copy link
Member

Choose a reason for hiding this comment

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

one last comment.
just looking at this language, can we relax it a bit? i'm not sure how to do this.

For instance sumana - she is giving a keynote and it an incredible person who i want to highlight. i don't know her well so she might be surprised to be considered "part of pyos community" ... similarly sarah kaiser might also be surprised? i may be WAY too sensitive i just don't want some of the people here who i really respect but haven't been directly engaged with pyos (vs i have spoken with them individually, etc) to be surprised by the language. Maybe it could say somethin glike - every talk keynote ... where ou can meet pyos community members and other people doing incredibly important work in the python community (or whatever words you think is best just to relax things a bit).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not a problem!

@kierisi kierisi merged commit 18e587a into main May 15, 2024
@kierisi kierisi deleted the pyos-at-pycon branch May 15, 2024 19:26
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.

2 participants