Commit graph

8 commits

Author SHA1 Message Date
Campbell Barton
0640836baa PyDoc: number all examples to avoid conflicts when type checking
Examples were supported with/without number suffix,
this caused problems using mypy for type checking because it attempted
to resolve imports such as `mathutils` to the example file.

Having only some examples numbered already complicated documentation
for conventions with examples - simplify extraction and number all.
2026-02-12 00:51:02 +00:00
Campbell Barton
b2c57fd877 PyDoc: use complete sentences in comments for templates & examples 2025-04-02 23:46:58 +00:00
Jorge Bernal
970c928f27 Py API Docs: Fix audio docs example
After new AUD API changes from 2.8x what "buffer" function used to do
has now become "cache" function (it caches a sound into RAM). Therefore,
the basic aud example should call this new "cache" function instead of
"buffer" function.

Thanks to Michael-Z-Freeman for pointing out.
2021-09-18 19:28:55 +02:00
Aaron Carlisle
817c38f715 PyAPI Docs: Update aud example
Fixes T74641
2020-03-19 16:21:17 -04:00
Campbell Barton
f184202a9a Cleanup: API docs 2015-09-08 19:42:58 +10:00
Joerg Mueller
a4a09fc638 Fix for [#28792] Invalid 'aud' documentation examples. 2011-10-02 18:00:06 +00:00
Campbell Barton
93bb6238e0 remove some unused flags and correct aud example heading 2011-06-27 07:44:59 +00:00
Dalai Felinto
9dbec62bc0 basic sound playback example for audspace module
(I'm on windows at the moment so I can't test it. Hopefully it should be fine)
2011-06-27 05:12:03 +00:00