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

Add some docstrings for Frame base class #372

Closed
wants to merge 1 commit into from

Conversation

jlaine
Copy link
Collaborator

@jlaine jlaine commented Sep 18, 2018

This PR adds docstrings for the Frame base class, notably about timestamps.

I couldn't figure out how to document index and planes which are defined in the .pxd file, any hints?

@jlaine
Copy link
Collaborator Author

jlaine commented Sep 18, 2018

Let me know whether you have a preference as to whether or not I should include the :type: for each property. Thanks!

@mikeboers
Copy link
Member

Cherry-picked onto develop.

I like being more specific by having the :type:, even though the template is rendering that page not very nicely.

I also want to look into hosting multiple versions of the docs, cause I didn't just build and deploy it cause I'm not going to necessarily cut a new release into PyPI right away.

@mikeboers mikeboers closed this Sep 19, 2018
@jlaine
Copy link
Collaborator Author

jlaine commented Sep 19, 2018

readthedocs.org handles a "latest" and "stable" out of the box and I'm almost sure you can add more versions.

Sad to hear no pypi release in sight, I could have done with the timestamp fixes for a MediaPlayer class I'm adding to my WebRTC implementation:

https://github.com/jlaine/aiortc/blob/48ea3aa6f27c4f999937d24b0213c44c3dd7b394/aiortc/contrib/media.py#L190

Anything I can do to help push out a minor release?

@mikeboers
Copy link
Member

I've moved the docs to my own hosting, and wrote a tiny Javascript thing to add a Dropdown at the top. See http://docs.mikeboers.com/pyav/develop/

This project would be far too hard to get to build on RTD, that I gave up long ago.

I suppose you've already done a ton to help push out a release, because so much more passes now, right? With that being the case, there isn't really anything stopping me from doing it...

@jlaine
Copy link
Collaborator Author

jlaine commented Sep 19, 2018

Very cool! Next on my list is:

  • contributing some examples to the docs especially for reading audio/video using PyAV

  • contributing more docstrings. I don't know if you saw my question about how to document properties defined in .pxd files?

  • I've been reading up on cython and it would seem we can / are encouraged to use normal @Property / @propname.setter syntax. Do we want a global pass on this?

@mikeboers
Copy link
Member

You're my hero.

  1. Examples. The examples directory is there, but many of them are way too heavy with diagnostic stuff because I use them while developing. I was hoping to start putting lots of simpler focused examples in docs/examples.

I'm not keen on the current setup with the testcode blocks, as I don't get highlighting over here, and I can't run them, etc.. I was thinking of making a directive to include a Python file, and scrub out common stuff that we don't need to see in the docs (e.g. import av, or even larger blocks of setup.)

  1. I don't know if I saw the thing about PXD docstrings. So many notifications! Ah! Please feel free to email me at mail-at-mikeboers.com if you want.

  2. As long as we don't have to raise the Cython version bar (which I just set to 0.27), then I'm all for a pass for the new syntax. One less thing for people to learn about Cython!

@jlaine jlaine deleted the frame-docstrings branch October 13, 2018 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants