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

minor corrections related to recent python code updates that make the example run #288

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

jf---
Copy link
Contributor

@jf--- jf--- commented Sep 20, 2024

fix up the example

@jf--- jf--- force-pushed the jf/fixup_gh_example branch 3 times, most recently from 9733d37 to 8038a30 Compare September 20, 2024 15:11
@chenkasirer chenkasirer added the no changelog No changes to CHANGELOG.md required in this PR label Sep 25, 2024
Copy link
Contributor

@chenkasirer chenkasirer left a comment

Choose a reason for hiding this comment

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

LGTM
@jf--- thanks so much for fixing the example file!

Question: do you think we should make a new example doc for each new release and keep them separates in folders GH_0.10.0, GH_0.11.0 etc,?
Currently we try to update in-place but evidently we often miss stuff and then it's not clear with which version this file goes.

Would love to get your input.

@jf---
Copy link
Contributor Author

jf--- commented Sep 25, 2024

@jf--- thanks so much for fixing the example file!

its a marginal fix ;)
the demo at the compas assoc. event was awe inspiring, love the architecture of the sw; nice & clean.

Question: do you think we should make a new example doc for each new release and keep them separates in folders GH_0.10.0, GH_0.11.0 etc,?

hard to answer: thing is that often, example code isn't ran in CI, and I think that is the issue
the irony in examples (generally speaking) is that its the code 1st exposed to your audience, therefore its key to the project. for pure python examples, I'd say add a few assert statements and then the fact that it runs makes it a viable demo, and add it to pytest. it would be amazing if CI test could be included to grasshopper nodes too, sharing "if it runs its complete" approach?

that was the hugely indirect answer; the direct answer to your versioning question is no 😉

I think that in the compas sphere in general, that too many releases perhaps occur, and its hard for components and dependencies to interact accordingly. It would be welcome to have a rhythm in the compas sphere and perhaps agree that the compas association supports quarterly releases? It could be fun actually, it's a good reason to meet and synchronise.

I'd much rather prefer a quarterly release that's solid and has pinned dependencies.

Versioning introduces another dimension, and it's not fun going back and forth. KISS for now?

@chenkasirer chenkasirer merged commit a6c2e9d into gramaziokohler:main Sep 25, 2024
14 of 15 checks passed
@chenkasirer
Copy link
Contributor

hard to answer: thing is that often, example code isn't ran in CI, and I think that is the issue the irony in examples (generally speaking) is that its the code 1st exposed to your audience, therefore its key to the project. for pure python examples, I'd say add a few assert statements and then the fact that it runs makes it a viable demo, and add it to pytest. it would be amazing if CI test could be included to grasshopper nodes too, sharing "if it runs its complete" approach?

I like the idea of adding asserts to the example code!
How I wish Grasshopper becomes first-class in this whole SW pipeline, that's unfortunately far from happening I think. But small steps are being made.. let's see.

I think that in the compas sphere in general, that too many releases perhaps occur, and its hard for components and dependencies to interact accordingly. It would be welcome to have a rhythm in the compas sphere and perhaps agree that the compas association supports quarterly releases? It could be fun actually, it's a good reason to meet and synchronise.

I'd much rather prefer a quarterly release that's solid and has pinned dependencies.

Here I disagree a bit. we have actually been discussing having even more frequent release schedule, even automate it on a weekly basis. Quarterly releases or even monthly can be frustratingly slow for extension developers (myself included). But perhaps this should be about communication. Have well communicated quarterly package with all sorts of tested example file etc. could be a great compromise.

Anyways, KISS for now it is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog No changes to CHANGELOG.md required in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants