veyepar: The Value of Docstrings

Hi user

Admin Login:

Name: The Value of Docstrings
--client pyohio --show pyohio_2019 --room barbietootle 14872 --force
Prev: 12 The Magic of Python
Next: 12 Sipping the Nectar of Amazon from the Serverless Chalice

show more...

Author(s):	Eric Appelt
Location	Barbie Tootle
Date	jul Sat 27	Days Raw Files
Start	15:45	First Raw Start	15:24
Duration	0:30:0	Offset	0:20:29
End	16:15	Last Raw End	16:24
Chapters	00:00 0:09:58 0:19:07 0:27:49
Total cuts_time	27 min.

https://www.pyohio.org/2019/presentations/84
raw-playlist raw-mp4-playlist encoded-files-playlist host archive tweet mp4 svg png

final audio

assets release.pdf The_Value_of_Docstrings.json
logs
Admin: episode episode list cut list raw files day marks day marks day image_files

State:
Locked:	clear this to unlock
Locked by:	user/process that locked.
Start:	initially scheduled time from master, adjusted to match reality
Duration:	length in hh:mm:ss
Name:	Video Title (shows in video search results)
Emails:	email(s) of the presenter(s)
Released:	has someone authorised pubication
Normalise:
Channelcopy:	m=mono, 01=copy left to right, 10=right to left, 00=ignore.
Thumbnail:	filename.png
Description:	Python docstrings differ from regular comments in that they are stored as an attribute of a callable object and are accessible through the help() builtin function. However, their importance in writing readable and maintainable python modules has very little to do with their technical language features in Python, and much more to do with the discipline they bring to effective documentation. Any new developer will encounter well reasoned advice on the need to comprehensively comment their code, and contrary but equally reasonable advice to avoid using comments at all by writing better code. This talk will briefly explore these viewpoints, and then review the standard conventions for Python docstrings. I argue that the consistent and conventional use of Python docstrings results in more readable and maintainable code than that written with only unstructured comments, independent of how sparse or plentiful those comments may be. Additional areas of improvement in software design are discussed, including effective encapsulation, the difficulty of naming methods, "docstring driven development", extension into external documentation, and integration with testing. Finally, I argue that Python docstring conventions are a model for improved software design in general, and are worth adopting even in other languages that do not necessarily support actual docstrings. Docstrings are a common convention in Python programming, but their value may be taken for granted. In the absence of docstrings, schools of thought on writing effective code involve using many comments or using few if any comments. I will argue that docstrings improve upon these approaches, and then explore how they can positively impact encapsulation, testing, documentation, and design. markdown
Comment:	delay=1.0 The audio is constantly out of sync by about 1 second. The audio stops at 19:08 production notes

recording sheet

recording sheet

2019-07-27/15_24_31.ts Apply: 15:24:31 - 15:25:05 ( 00:00:34 ) S: 15:24:31 - E: 15:54:31 D: 00:30:00 (End: 34.0) show more...

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_24_31.ts :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	15:24:31		seconds: 0.0 Wall: 15:24:31
Duration	00:30:00
	15:54:31		seconds: 34.0 Wall: 15:25:05
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

2019-07-27/15_24_31.ts Apply: 15:25:05 - 15:44:33 ( 00:19:28 ) S: 15:24:31 - E: 15:54:31 D: 00:30:00 (Start: 34.0) (End: 1202.0) show more...

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_24_31.ts :start-time=034.0 --audio-desync=0

	Raw File	Cut List
	15:24:31		seconds: 34.0 Wall: 15:25:05
Duration	00:30:00
	15:54:31		seconds: 1202.0 Wall: 15:44:33
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

2019-07-27/15_24_31.ts Apply: 15:44:33 - 15:54:31 ( 00:09:58 ) S: 15:24:31 - E: 15:54:31 D: 00:30:00 (Start: 1202.0) show more...

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_24_31.ts :start-time=01202.0 --audio-desync=0

	Raw File	Cut List
	15:24:31		seconds: 1202.0 Wall: 15:44:33
Duration	00:30:00
	15:54:31		seconds: 0.0 Wall: 15:24:31
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

2019-07-27/15_54_31.ts Apply: 15:54:31 - 16:03:40 ( 00:09:09 ) S: 15:54:31 - E: 16:24:31 D: 00:30:00 (End: 549.311833) show more...

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_54_31.ts :start-time=00.0 --audio-desync=0

	Raw File	Cut List
	15:54:31		seconds: 0.0 Wall: 15:54:31
Duration	00:30:00
	16:24:31		seconds: 549.311833 Wall: 16:03:40
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

2019-07-27/15_54_31.ts Apply: 16:03:40 - 16:12:23 ( 00:08:42 ) S: 15:54:31 - E: 16:24:31 D: 00:30:00 (Start: 549.311833) (End: 1072.0) show more... channelcopy=10

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_54_31.ts :start-time=0549.311833 --audio-desync=0

	Raw File	Cut List
	15:54:31		seconds: 549.311833 Wall: 16:03:40
Duration	00:30:00
	16:24:31		seconds: 1072.0 Wall: 16:12:23
Comments:		channelcopy=10
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

2019-07-27/15_54_31.ts Apply: 16:12:23 - 16:12:29 ( 00:00:06 ) S: 15:54:31 - E: 16:24:31 D: 00:30:00 (Start: 1072.0) (End: 1078.0) show more... channelcopy=10

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_54_31.ts :start-time=01072.0 --audio-desync=0

	Raw File	Cut List
	15:54:31		seconds: 1072.0 Wall: 16:12:23
Duration	00:30:00
	16:24:31		seconds: 1078.0 Wall: 16:12:29
Comments:		channelcopy=10
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

2019-07-27/15_54_31.ts Apply: 16:12:29 - 16:24:31 ( 00:12:02 ) S: 15:54:31 - E: 16:24:31 D: 00:30:00 (Start: 1078.0) show more...

vlc ~/Videos/veyepar/pyohio/pyohio_2019/dv/barbietootle/2019-07-27/15_54_31.ts :start-time=01078.0 --audio-desync=0

	Raw File	Cut List
	15:54:31		seconds: 1078.0 Wall: 16:12:29
Duration	00:30:00
	16:24:31		seconds: 0.0 Wall: 15:54:31
Comments:
mp4 mp4.m3u	dv.m3u	Split: Sequence:: delete

audio viz

Rf filename:	root is .../show/dv/location/, example: 2013-03-13/13:13:30.dv
Sequence:
get this:	check and save to add this

(0:19:07) channelcopy=10

(0:27:49) channelcopy=10

2019-07-27/15_24_31.ts
audio viz

audio viz

2019-07-27/15_54_31.ts
audio viz

audio viz

Veyepar Video Eyeball Processor and Review