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

Documentation of language basics "Conditional Compilation" is wrong and broken for Windows #1998

Open
derekbrokeit opened this Issue Nov 14, 2017 · 1 comment

Comments

Projects
None yet
2 participants
@derekbrokeit

derekbrokeit commented Nov 14, 2017

The documentation for Conditional Compilation references the source of basic defined variables such as "UNAME_SYSNAME" and others using the following phrasing:

corresponding to the values returned by :func:`os.uname`.

This is technically incorrect because the actual source of these variables in Cython is platform.uname(), but the serious problem is that os.uname does not even exist on the Windows platform. This makes it difficult for new users to understand what to expect when using Conditional Compilation if they are developing on Windows.

I recommend updating the source of the documentation to reflect this. I am new to this community and not certain of the pull request rules (especially regarding documentation), so I have not yet prepared a pull request.

@scoder

This comment has been minimized.

Show comment
Hide comment
@scoder

scoder Nov 15, 2017

Contributor

Please just send a PR. Platforms specific fixes are generally maintained by people using that platform.

Contributor

scoder commented Nov 15, 2017

Please just send a PR. Platforms specific fixes are generally maintained by people using that platform.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment