JuliaAcademy / JuliaAcademy/DataScience
Switch documentation access in Jupyter notebooks to @doc as to ensure compatibility with VS Code
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 533
- Forks
- 266
- PR merge metrics
- No merged PRs in 30d
Description
In the lecture notebooks, ?command is used to access the documentation within Juptyer notebooks. Unfortunately, this will not work out when the notebooks are run from within Visual Studio Code, which has many advantages and imo is the most often used IDE for Julia.
I would suggest that you change this to @doc command in the notebooks, which will work out in VS Code as well (note that one currently needs to switch output presentation from LaTeX to Markdown in VS Code due to issues with the verbatim environment).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the lecture notebooks for uses of ?command and review how documentation is accessed in those cells. Update the relevant notebook cells to use @doc command, then verify that documentation displays correctly when the notebooks are opened in Visual Studio Code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia, jupyter-notebook, vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100