Typo in globals.h? #432
Replies: 5 comments 10 replies
-
|
Yep, that looks like a typo to me. "Fans" should probably be interpreted as "devices that provide cooling to desktop computers", as that is one of the projects Dave put together with this before he open sourced it. |
Beta Was this translation helpful? Give feedback.
-
|
Almost certainly. If you have something you're sure is a typo or needs improved words that you can provide, I'd suggest just clicking edit (the little pencil) and preparing a change. If it passes review (agreement that you left it better than you found it), someone with approval privs (almost always Rutger) can then just click a button to apply it. Doc changes are much easier to integrate than code changes, which currently, to my knowledge, still require a human (again, usually Rutger) to touch-test them on a reasonable subset of the hardware population before applying them. It's been my own experience that doc changes are pretty easy to get approved and integrated. As we get more eyes on them, we have both the blessing of more hands to fix them and the curse (well, that's perhaps overstated) of more eyeballs actually reading them and possibly getting mislead by glitches. I think more hands on the doc in this project will help it a lot. It's a problem in every code base I've worked with that the doc is read by people new to the project and they expect it to make sense. The people that have worked on the code forever, perhaps the same people that introduced changes that invalidate the doc, will develop blindness to the doc because THEY aren't the ones reading it. This is why input from new members is particularly valuable and this project is pretty good about welcoming input. I still don't really get "rings", but it's pretty clear that "fangs" |
Beta Was this translation helpful? Give feedback.
-
|
@rbergen, oh yeah sure, FANS, @davepl computer fan illuminations YT mentions with WS2812 strips! Thanks for information on editing docs. I'll do that. |
Beta Was this translation helpful? Give feedback.
-
|
So I'm only working with a local copy of NightDriverStrip. I can edit it and save easily. Don't yet know the ins and outs of being a "collaborative actor". |
Beta Was this translation helpful? Give feedback.
-
|
Good. For easy changes that don't need compilation/testing, like a few
words in a doc, just clicking the edit button on the page of, say,
https://github.com/PlummersSoftwareLLC/NightDriverStrip/blob/main/include/globals.h
and then letting it create the branch and pull request for you is probably
fine.
For things that need you to build them and that'll thus need non-trivial
review and testing from Rutger or Dave to be integrated, you'll need to
build it yourself to be sure everything works, then open a pull request
from your local, tested, tree.. Use your favorite search engine for
[github make pull request] and then boil down to a combination of operating
system and tools that you find comfortable. For example, there is a
'GitHub Desktop' thingy that some people like to help with that process. I
personally use the 'gh <https://cli.github.com/>' tool, which is admittedly
not for everyone. There are professional tools that help once you start to
have professional-level problems. There's GH's own official guidance.
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>
There
are LOTS of pages on this, so I'll just point you in the right direction.
…On Sun, Sep 17, 2023 at 3:28 PM airnocker ***@***.***> wrote:
So I'm only working with a local copy of NightDriverStrip. I can edit it
and save easily. Don't yet know the ins and outs of being a "collaborative
actor".
—
Reply to this email directly, view it on GitHub
<#432 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ACCSD33ORBNSH2QAV6HQ6HLX25MOFANCNFSM6AAAAAA43NPUQE>
.
You are receiving this because you commented.Message ID:
<PlummersSoftwareLLC/NightDriverStrip/repo-discussions/432/comments/7028404
@github.com>
|
Beta Was this translation helpful? Give feedback.
-
|
I made the change with the link you provided on dave's nightdriverstrip page, very easy to do, thanks. |
Beta Was this translation helpful? Give feedback.
-
|
@airnocker I've corrected this typo in a branch in my fork with (otherwise unrelated) changes I'm currently working on. As such, the correction will get pulled in with an upcoming larger update to the project. |
Beta Was this translation helpful? Give feedback.
-
|
@airnocker This may sound a bit pedantic which is not my intention, but I can't help how others named things:
It's the combination that can yield very powerful collaborative development experiences, one gets their head around both - which I will be the first to say involves a pretty steep learning curve. I'm pretty sure the login PIO asks for concerns GitHub. My request concerns the output of git - which may tell us it's not even installed, but that in itself would also me help answering your original question. |
Beta Was this translation helpful? Give feedback.
-
|
@rbergen I replied with the results of the git command and do understand git vs GitHub. I may have posted the git results in one of our other threads because I don't see it here. |
Beta Was this translation helpful? Give feedback.
-
|
I'm not sure where your git command output ended up then. I searched my email and didn't receive a notification of a comment mentioning git in the past 48 hours or so - except for this one. |
Beta Was this translation helpful? Give feedback.
-
|
Hmm, it appears I took a screenshot of the 'git remote -v' result and then failed to "send" it to you. My apologies. So here it is:
|
Beta Was this translation helpful? Give feedback.
-
|
No worries. In that case a "git pull" should do it in principle. Do note that if you have any uncommitted local modifications to your existing local version, git may insist on you reverting or stashing them. If you have any committed local changes you may have (a) merge conflict(s) to resolve. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Line 236 // LEDs, how many, on how many channels, laid out into how many fang/rings, and so on.
Do you mean "fans/rings"? i.e. like how many fans (straight lines) of strips?
airnocker (Alden G)
Beta Was this translation helpful? Give feedback.
All reactions