[GH-ISSUE #280] Documentation #808

New issue

Closed

opened 2026-03-15 10:33:37 +03:00 by kerem · 2 comments

kerem commented

2026-03-15 10:33:37 +03:00

Owner

Originally created by @KingAkeem on GitHub (Mar 23, 2018).
Original GitHub issue: https://github.com/asciinema/asciinema/issues/280

Hey i'm new to the project and I'd like to contribute. I was looking through the source code and noticed that there was almost no documentation. I'd like to go through and document the code for my first contribution. Possibly using a Google Style guide for documentation. Here are examples of what it'd look like: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

Originally created by @KingAkeem on GitHub (Mar 23, 2018). Original GitHub issue: https://github.com/asciinema/asciinema/issues/280 Hey i'm new to the project and I'd like to contribute. I was looking through the source code and noticed that there was almost no documentation. I'd like to go through and document the code for my first contribution. Possibly using a Google Style guide for documentation. Here are examples of what it'd look like: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

kerem closed this issue

2026-03-15 10:33:42 +03:00

kerem commented

2026-03-15 10:33:48 +03:00

Author

Owner

@ku1ik commented on GitHub (Apr 21, 2018):

Hey Akeem! That sounds great. Indeed there's very little documentation of the functions. If you're still up for it then I'd be happy to receive some PRs. Let me know if you have any questions about the code!

@ku1ik commented on GitHub (Apr 21, 2018): Hey Akeem! That sounds great. Indeed there's very little documentation of the functions. If you're still up for it then I'd be happy to receive some PRs. Let me know if you have any questions about the code!

kerem commented

2026-03-15 10:33:53 +03:00

Author

Owner

@KingAkeem commented on GitHub (Apr 22, 2018):

Awesome, thanks! I'm going to take a look now. I let you know if I have any questions, thanks again!

@KingAkeem commented on GitHub (Apr 22, 2018): Awesome, thanks! I'm going to take a look now. I let you know if I have any questions, thanks again!