Aaron Carlisle
adcce654e3
Cleanup: Use correct capitalization of "F-Curve"
2022-04-18 20:17:41 -04:00
Myles Walcott
880e85fc80
Cleanup: Grammar in doc/python_api
...
* Its -> It's
* Scripts -> Script's
* then -> than
Several phrasing grammar fixes.
Reviewed By: Blendify
Differential Revision: https://developer.blender.org/D14021
2022-02-07 14:28:12 -05:00
Hans Goudey
46475b8e11
Cleanup: Grammar: its self vs. itself
2022-01-23 22:34:56 -06:00
Clément Foucault
a6d1a2d3fc
Merge branch 'blender-v3.0-release'
2021-11-23 14:08:53 +01:00
Jeroen Bakker
6ab3349bd4
Documentation: Remove deprecated glColor* from bgl module.
...
glColor isn't supported but still part of the documentation. This
patch removes the glColor from the documentation.
Ref {T93315}
2021-11-23 13:03:12 +01:00
luzpaz
dea26253a0
cleanup: fix typos in comments and docs
...
Followup to https://developer.blender.org/D10288
Reviewed By: Blendify
Differential Revision: https://developer.blender.org/D10346
2021-11-16 18:45:10 -05:00
Campbell Barton
7ccd19fc12
PyAPI: update docs to include poll_message_set reference
...
Part of D9738
2021-04-20 12:29:04 +10:00
Aaron Carlisle
97072e0135
Py Doc: Fix rst syntax errors
2021-02-12 13:14:43 -05:00
Aaron Carlisle
5530d6f86f
PyAPI Docs: Terminal instructions for Windows incorrect
...
Fixes T84498
2021-01-07 15:58:47 -05:00
Aaron Carlisle
27426c05b1
PyAPI Docs: Link to user docs instead of describing in API doc
2021-01-06 19:52:13 -05:00
Aaron Carlisle
b138c8f5b3
PyAPI Docs: Update Indirect Data Access docs
...
Fixes T84432
2021-01-06 19:34:21 -05:00
Aaron Carlisle
a9c607e60e
PyAPI Docs: Fix wrong modifier path usage
...
Fixes T84430
2021-01-06 18:54:56 -05:00
Aaron Carlisle
133bdac306
PyAPI Docs: Clarify quick start guide tips
...
Some of the text here was outdated with 2.8x.
See T84427
2021-01-06 18:45:34 -05:00
Campbell Barton
a0db43cd7b
Fix T84388: Invalid operator reference in the quick-start
2021-01-05 15:51:50 +11:00
Aaron Carlisle
cf778a9e42
Pydoc: BGL: update links
2020-10-11 20:14:16 -04:00
Campbell Barton
05710171cb
PyDoc: resolve duplicate module warnings
...
Remove submodule listings from the module docstring,
as this information already exists in the generator.
2020-10-09 12:11:00 +11:00
Aaron Carlisle
c4a281e801
PyDoc: Use explicit class names to refence class
...
This fixes the link and makes it more clear which class the note is
talking about
2020-10-07 17:25:19 -04:00
Campbell Barton
28ebe827e6
Cleanup: trailing space
2020-10-02 11:59:16 +10:00
Bastien Montagne
211d213160
API doc: Gotcha's: Add section about abusing RNA properties callbacks.
...
Especially with new undo/redo it is even less recommended to perform
complex operations in those callbacks, they should remain as fast and
localized as possible.
Also updated the section about undo/redo a bit.
2020-09-14 11:02:52 +02:00
Aaron Carlisle
9498eb2692
API Docs: Update Changelog from 2.83
2020-08-24 10:38:17 -04:00
Campbell Barton
20446f07f6
Docs: reference bl_rna_get_subclass_py instead of bl_rna_get_subclass
...
bl_rna_get_subclass only works for Nodes at the moment.
2020-07-06 23:07:18 +10:00
Aaron Carlisle
b0449cac66
API Docs: Small edits to recent commit
...
- Revert string formatting change
- Add missing text edit
2020-06-23 17:10:07 -04:00
Tobias Heinke
23f8ab4250
API docs: intro overhaul
...
- Update terminology, spelling, formatting.
- Rename screen to workspace.
- Update for 2.8 UI changes.
2020-06-23 23:13:10 +10:00
Campbell Barton
f4d65b0d6e
Docs: update API docs, adding reference to bl_rna_get_subclass.
2020-05-11 15:48:51 +10:00
Campbell Barton
3d3a91103b
Doc: remove MeshTessFace reference
2020-03-24 16:26:07 +11:00
Aaron Carlisle
7177862313
API Docs: Point to manual for Operator Cheat Sheet
2020-03-06 12:50:19 -05:00
Ian Karanja
73e404697b
Fix small typo in BGL API docs
...
Differential Revision: https://developer.blender.org/D6681
2020-02-14 17:59:00 +01:00
Campbell Barton
7d6c08beb8
Doc: simplify T72883 fix
...
Code example made it seem setting the active object was more complex
than a single assignment.
2020-02-11 11:27:01 +11:00
Aaron Carlisle
189e96ba68
Fix T72883: Correct Context Usage
2020-02-10 14:08:34 -05:00
Campbell Barton
12b183ba55
Docs: update reference to PYTHONPATH
2020-01-25 20:15:38 +11:00
Bastien Montagne
eb798de101
Clean/Fix remaining cases of props assignments in resgistrable structs def.
...
We still had a few deprecated assignements of `bpy.props.xxx` to class
members in our API documentation and one of our py tests. Annotations
are to be used now.
Also remove the section about `register_module` utils, this has been
removed in 2.8.
Fix T71877: Python API overview sample code warning: class MyMaterialProps contains a property which should be an annotation!
Fix T71876: Python API overview references old bpy.utils.register_module function
2019-11-27 12:19:10 +01:00
Campbell Barton
7137d1470a
Docs: update link
2019-09-13 07:46:25 +10:00
Aaron Carlisle
5e77fb2482
API Docs: Correct Hotkey
...
Here we can link to the manual and keep the hotkey updated in the manual
rather than the API docs.
Fixes T68371
2019-08-07 17:20:40 -04:00
Brecht Van Lommel
604fdb6e85
Spelling fixes in comments and descriptions, patch by luzpaz
...
Differential Revision: https://developer.blender.org/D3744
2019-07-31 14:27:35 +02:00
Aaron Carlisle
313097c267
API Docs: Fix Links
2019-07-06 19:46:05 -04:00
Aaron Carlisle
e1fbab12dc
API Docs: Update Changlog for 2.80
2019-07-06 17:01:11 -04:00
Jeroen Bakker
669d50f803
Fix T66405: Python API documentation
...
removed glVertex from the Python bgl api documentation as they are
deprecated.
2019-07-04 09:19:48 +02:00
Bastien Montagne
33e8db94b1
Fix (unreported) missing updates in scripts/docs after scene.update() removal.
...
This should really have been done together with API changes, simple
usage of grep does the trick to catch most places needing updates.
2019-06-04 14:39:51 +02:00
Campbell Barton
351e68e0a4
Docs: update quick-start
...
Resolves T64146
2019-06-04 13:12:59 +10:00
Jacques Lucke
3c7a538c9b
Fix T60891: bgl docs still include deprecated opengl functions
...
In a separate step, all new functions should be added.
However, the best way to do this, is not clear yet.
A list of functions, that have to be added is available
in D4280.
Differential Revision: https://developer.blender.org/D4280
2019-04-04 16:14:59 +02:00
Bastien Montagne
8ba1c3072c
API Doc: Gotcha: add section about 'exceptions to the rules' known crashing cases.
...
As exposed in T62406, we can have some rare cases of crashes due to
memory re-allocation happening outside of expected scenarii.
Ideally this should be re-designed, but at least keep track of those
known exceptions to general rules...
2019-03-12 14:12:46 +01:00
Bastien Montagne
49c100e56c
API doc: info_gotcha: extend description of issues related to memory changes.
...
* Added a TL;DR first paragraph summarizing that one shall not keep any
reference to Blender data when modifying its container.
* Added some info about fact that adding items to some data containers
(like Collection) can also invalidate existing items (due to array
re-allocation).
* Added a Do/Don't example which shows a crash after adding some items
to a collection.
Related to T61297.
2019-02-18 14:36:16 +01:00
Bastien Montagne
9299073d57
Cleanup: API doc 'info_gotcha': typos.
2019-02-18 14:36:16 +01:00
Campbell Barton
f81aeac2bc
Docs: rename group -> collection
2018-11-30 09:10:40 +11:00
Campbell Barton
2a8f6946fe
Docs: update quickstart for 2.8
2018-11-30 08:53:36 +11:00
Campbell Barton
6af997710b
Merge branch 'master' into blender2.8
2018-11-30 08:39:59 +11:00
Campbell Barton
8ac2d85d2f
Cleanup: trailing space
2018-11-30 08:38:25 +11:00
Brecht Van Lommel
e65784a051
Python API: add loop triangles access, remove tessfaces.
...
Loop triangles are tessellated triangles create from polygons, for renderers
or exporters that need to match Blender's polygon tesselation exactly. These
are a read-only runtime cache.
Tessfaces are a legacy data structure from before Blender supported n-gons,
and were already mostly removed from the C code.
Details on porting code to loop triangles is in the release notes.
Differential Revision: https://developer.blender.org/D3539
2018-10-10 17:43:44 +02:00
Brecht Van Lommel
6b433f4eb3
Merge branch 'master' into blender2.8
2018-09-19 18:20:50 +02:00
Brecht Van Lommel
a4f2ebc78d
Spelling fixes in comments and descriptions, patch by luzpaz.
...
Differential Revision: https://developer.blender.org/D3700
2018-09-19 18:18:05 +02:00