Remove specific software name from header in docs #795
Conversation
Python is mentioned in the docs, but then the example uses Node JS. I am new to Nix, so I don't want to update the example to fully use Python, so I did the simpler change of fixing the heading and mention of Python to instead say Node JS. If someone wants to fix the example code, or change the text to NodeJS or Node.JS, or whatever, by all means. My goal here is just to make the docs more clear. Thanks!
|
The Python bit is an artifact from a rewrite of the article. But it's already fixed here, just from two days ago: #793 Thanks for the attention to detail though! |
|
Oh, I see. Okay 👍🏼 It does look like #793 missed the header, though. |
There's enough detail about it below, and the specific tech isn't the point of this section anyway. Co-authored-by: Valentin Gagarin <[email protected]>
addison-grant
changed the title
|
@fricklerhandwerk, I think this is good to go or ready for review now. Thanks! |
|
Generally we prefer not having merge commits in PRs. But since this is just a single change we can also squash merge, so there's no problem with it. Keep this in mind in case you have a multi-commit PR in the future! |
Okay, I'll keep it in mind! |
The original reason for this pull request has mostly been resolved in #793, except for the header of the section of interest. The section originally mentioned Python, then the example was updated to concern Node.js. After a little discussion, removing the specific software name from the header was suggested, so that's what I've done here.
Original Pull Request description.
Python is mentioned in the docs, but then the example uses Node JS. I am new to Nix, so I don't want to update the example to fully use Python, so I did the simpler change of fixing the heading and mention of Python to instead say Node JS.
If someone wants to fix the example code, or change the text to NodeJS or Node.JS, or whatever, by all means. My goal here is just to make the docs more clear. Thanks!
I don't know if there's some build process that will fix the Table of Contents on the right-hand side: