realpython / realpython/materials
Linux only tutorial fails to identify as such
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 5.2k
- Forks
- 5.3k
- Avg merge
- 4d 10h
- Merged PRs (30d)
- 10
Description
This tutorial using this code only works on linux. Unfortunately I had to find out myself, since the tutorial doesn't really make it clear. To make this work with MSVC a lot needs to be changed, including all the compiling, the C/C++ source files, some of file path stuff and more. Even when using GCC most of the issues remain.
I suggest adding a big disclaimer that the tutorial is only for linux or even better, expanding it so that the rest of us can follow along too :(
@jima80525
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
Read the tutorial's “Setting Up Your Environment” section and inspect the linked materials at python-bindings/overview_article. Decide whether the scope is a clear Linux-only disclaimer or broader MSVC/GCC support; done means the platform limitation is explicit, or the tutorial and examples work for the additional platform.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, cpp, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100