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

nixos/jupyter: Fix documentation example for jupyter.kernels #56415

Merged
merged 2 commits into from Jan 31, 2020

Conversation

@BenSchZA
Copy link
Contributor

@BenSchZA BenSchZA commented Feb 26, 2019

Motivation for this change

The environment variable loading fails when using the example for kernels config, due to incorrect syntax. The error being something along the lines of path not found. The same is true for the loading of the relevant icons from path.

This change is a simple update of the service documentation.

Things done
  • Built on platform(s)
    • NixOS
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.
The environment variable loading fails when using the example for `kernels` config, due to incorrect syntax. The error being something along the lines of `path not found`.
Copy link
Member

@FRidh FRidh left a comment

The variables need to be escaped correctly. This is an example, so we don't want it to actually evaluate them.

@FRidh
Copy link
Member

@FRidh FRidh commented Mar 3, 2019

If I am correct, it's indeed removing the spaces like you did, and replacing the single $ with $$.

layus added a commit to layus/nixpkgs that referenced this issue Jan 31, 2020
Fixes and closes NixOS#56415
Thanks at @BenSchZA for reporting.
@layus
Copy link
Member

@layus layus commented Jan 31, 2020

@BenSchZA Triage ping. Are you still interested in updating and getting this merged ?

@BenSchZA
Copy link
Contributor Author

@BenSchZA BenSchZA commented Jan 31, 2020

@layus Thanks for checking in. I've just seen the updates you made. Happy to update and get this merged.

layus
layus approved these changes Jan 31, 2020
Copy link
Member

@layus layus left a comment

@FRidh I think this is ready

@FRidh FRidh merged commit 5d2a723 into NixOS:master Jan 31, 2020
13 checks passed
@BenSchZA BenSchZA deleted the jupyter-doc-update branch Jan 31, 2020
anna328p added a commit to anna328p/nixpkgs that referenced this issue Feb 2, 2020
…#56415)

* Fix documentation example for `jupyter.kernels`

The environment variable loading fails when using the example for `kernels` config, due to incorrect syntax. The error being something along the lines of `path not found`.

Thanks to @Infinisil and @layus for suggestions.
jpgu-epam added a commit to jpgu-epam/nixpkgs that referenced this issue Feb 4, 2020
…#56415)

* Fix documentation example for `jupyter.kernels`

The environment variable loading fails when using the example for `kernels` config, due to incorrect syntax. The error being something along the lines of `path not found`.

Thanks to @Infinisil and @layus for suggestions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants