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

Document new features in Cython 3.0 #3583

Open
scoder opened this issue May 7, 2020 · 2 comments
Open

Document new features in Cython 3.0 #3583

scoder opened this issue May 7, 2020 · 2 comments

Comments

@scoder
Copy link
Contributor

@scoder scoder commented May 7, 2020

It's time to look through the documentation to see if all new features have been documented and/or are findable for users in an appropriate place. This is a great beginners ticket because it allows playing with new Cython features and figuring out how they work.

  • look through CHANGES.rst to see what features are new in the latest 3.0 alpha versions and which seem to be worth mentioning
  • look in the documentation where you would expect this to be documented
  • if it's already covered, perfect
  • otherwise, search the documentation to see if it's mentioned elsewhere, and decide if that's the right place
  • if not, write a paragraph or two and/or add a cross-ref from places where you think it's also worth mentioning
  • if you add example code (examples are great!) make sure it compiles by adding it as a .pyx file under docs/examples/ to let the test suite pick it up
  • preferably, use separate commits/updates for the different features.
@scoder scoder added this to the 3.0 milestone May 8, 2020
@scoder scoder added the Testing label May 8, 2020
@da-woods
Copy link
Collaborator

@da-woods da-woods commented May 8, 2020

From a quick look through, features that stand out to me as currently undocumented include:

  • cython-3.0.pxd versioning - probably should be documented. I'll submit a PR with a sentence or two for this.
  • cdef properties. I wonder if the limitation to external cdef classes will be hard to explain without causing confusion?
  • limited api - probably shouldn't be documented until its a little more complete.
  • pythran - not strictly new to Cython 3, but I can find references to it in the changelog but no documentation at all. @serge-sans-paille ?
@serge-sans-paille
Copy link
Contributor

@serge-sans-paille serge-sans-paille commented May 11, 2020

@da-woods : the official doc is scarce, but here it is: https://cython.readthedocs.io/en/latest/src/userguide/numpy_pythran.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.