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

New landing page - optimize code #49

Open
lwasser opened this issue Oct 22, 2024 · 8 comments
Open

New landing page - optimize code #49

lwasser opened this issue Oct 22, 2024 · 8 comments
Labels
help wanted Extra attention is needed
Milestone

Comments

@lwasser
Copy link
Member

lwasser commented Oct 22, 2024

to avoid too much nesting, I've created a new section that is now called code-workflow-logic, but I think a better name could be "optimize code". This section will contain all of the checks, functions, and conditional-related lessons! we could create an overview of this section as a landing page. right now, I just used the About Functions page as an intro. but I think we could create a powerful page on the power of optimizing code for maintainability, effectiveness, and efficiency!

see here: https://www.pyopensci.org/lessons/
Screenshot 2024-10-22 at 10 38 47 AM

We could rename code-checks to be optimize your code and then have a landing page there

@lwasser lwasser added the help wanted Extra attention is needed label Oct 22, 2024
@willingc
Copy link
Contributor

@lwasser I love your improvement with the latest PR #48 ☀️

@lwasser
Copy link
Member Author

lwasser commented Oct 22, 2024

oooh thank you, @willingc !! 🚀 I really find the quick iterations on PRs that you suggested to be invaluable! vs than getting stuck on bigger PR's that seem to grow over time! So thank you for that guidance!!

@sneakers-the-rat
Copy link
Contributor

i also love it :)

if it was me, i would make one section "writing functions" and have that be the first four things in the code checks list there, and then "Handling variation" for conditionals and exceptions, but i don't have the full scope of the topics you want to cover, so you're the better judge!

@lwasser
Copy link
Member Author

lwasser commented Oct 22, 2024

@sneakers-the-rat you know - because these lessons have come together so quickly, i didn't fully flesh out the scope. With that said - I don't think they will change dramatically at this point now that I'm on to working on the share and publish code lessons.

So. if you would like to make a small pr with an updated homepage org following the suggestion above, it's welcome!! I suspect a year from now we will have a better grasp on all of the content!

@sneakers-the-rat
Copy link
Contributor

I was gonna say, cooking up new lessons up to the last minute sounds like exactly how i work, but i think capping it with a little breathing room is probably a good idea ;)

@lwasser
Copy link
Member Author

lwasser commented Oct 23, 2024

HAH! I've never pulled together this much content quite this quickly. I think the particularly unique element of this is that you and Carol and Jeremy all seem to be right there and ok with the pace of things!!

This has made it really fun seeing it all come together.

@sneakers-the-rat
Copy link
Contributor

sneakers-the-rat commented Oct 23, 2024

basically i am working, finish a chunk, my notifications are flooded, and so i get to take a 10m break seeing what you're up to. it's a good vibe.

@willingc willingc added this to the Fall festival milestone Oct 23, 2024
@willingc
Copy link
Contributor

Related to #65

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants