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

[BLOG] Add libsf_error_state: SciPy's first shared library #892

Merged
merged 31 commits into from
Jan 24, 2025

Conversation

steppi
Copy link
Contributor

@steppi steppi commented Dec 17, 2024

Sorry for accidentally targeting main with my first PR. Copied from before:

This is nearly done so I figured it was time to make a PR here. Irwin Zaid, who was involved in the work described has read this draft and given a thumbs up (after making a couple small suggestions).

I still need to add footnotes and write the conclusion section at the end, which currently has section header ##Reflections. It looks like I'll also need to go through and confirm the text styling bullet points.

Text styling

  • The blog is written with plain language (where relevant).
  • If there are headers, they use the proper header tags in order to do so (with only one level-one header).
  • All links describe where they link to (for example, check the Quansight labs website).
  • Any kind of styling that the author uses (for example, bold for emphasis) is consistent throughout the blog.

Non-text contents

  • Blog post featured image is in PNG or JPEG format, not SVG.
  • All content is represented as text (for example, images need alt text and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing gifs or videos.
  • If it were to be read as plain text, the blog still makes sense and no information is missing.

Copy link

vercel bot commented Dec 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
labs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 24, 2025 5:27pm

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Great write-up Albert! I like the structure of the story.

apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Show resolved Hide resolved
@steppi
Copy link
Contributor Author

steppi commented Dec 19, 2024

Thanks @rgommers for all of the suggestions. Me not understanding why the inplace build works but not dev.py seems to be most in need of fixing. I'll look into understanding what's really going on. The empty brackets were places to remind me where to put the footnotes later. I should have mentioned that in my PR message. I've added footnotes now, and a conclusion section, and will go through and implement all of your suggestions.

@rgommers
Copy link
Member

@steppi I fixed the RPATH handling description - please have a look.

Copy link
Contributor Author

@steppi steppi left a comment

Choose a reason for hiding this comment

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

Thanks @rgommers. I think I get it now. I left some suggestions which I hope did not change the meaning, trying to rewrite things using my own voice. Let me know if these look good.

apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
apps/labs/posts/libsf-error-state.md Outdated Show resolved Hide resolved
@rgommers
Copy link
Member

Thanks @steppi, those rewrites all looked good, so I merged them. Can you check the preview and see if you're happy with everything?

@steppi
Copy link
Contributor Author

steppi commented Jan 24, 2025

Thanks @steppi, those rewrites all looked good, so I merged them. Can you check the preview and see if you're happy with everything?

Thanks Ralf. I made a last minute fix to move a closing parenthesis to the correct position and updated the date of the post. It all looks good to me now.

@steppi
Copy link
Contributor Author

steppi commented Jan 24, 2025

Ha. Thanks Ralf

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Let's declare victory here:) Very nice post, thanks Albert!

@rgommers rgommers merged commit 165b46c into Quansight:develop Jan 24, 2025
2 checks passed
@rgommers rgommers added labs 🔭 Items related to the Labs website type: content 📝 labels Jan 24, 2025
@steppi
Copy link
Contributor Author

steppi commented Jan 24, 2025

@rgommers, is there anything I need to do to get this deployed on main? The instructions in the README say that labs blog-posts should be treated as code changes and follow the code-changes process which involves opening against develop, but I noticed just now that most (but not all) labs blog post pull requests are opened against main, and there is also a contradictory instruction I missed to open labs post pull requests against main. I guess the proper thing to do would be to cherry pick the commit over and open a new PR against main?

@rgommers
Copy link
Member

Argh - yes indeed, this changed recently and I believe the instructions are outdated. Can you open a new PR to sync the changes to main? And a separate one to fix the instructions to prevent more people from being confused?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
labs 🔭 Items related to the Labs website type: content 📝
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants