Skip to content

Commit 1eb7fad

Browse files
committed
Some fixes in README
- Some default parameters to Wavefront initializer was incorrect - Clarify why we are looping materials in example - A couple of typos
1 parent bb0d5e6 commit 1eb7fad

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ scene = pywavefront.Wavefront('something.obj')
3232

3333
A more complex example
3434

35-
* `strict` will raise an exception if unsupported features are found in the obj or mtl file. Default `True`.
36-
* `encoding` of the obj and mtl file(s). Default `utf-8`.
37-
* `create_materials` will create materials if mtl file is missing or obj file references non-exiting materials . Default `False`.
38-
* `parse` decides if parsing should start immediately. Default `False`.
35+
* `strict` (Default: `False`) will raise an exception if unsupported features are found in the obj or mtl file
36+
* `encoding` (Default: `utf-8`) of the obj and mtl file(s)
37+
* `create_materials` (Default: `False`) will create materials if mtl file is missing or obj file references non-existing materials
38+
* `parse` (Default: `True`) decides if parsing should start immediately.
3939

4040
```python
4141
import pywavefront
4242
scene = pywavefront.Wavefront('something.obj', strict=True, encoding="iso-8859-1", parse=False)
4343
scene.parse() # Explicit call to parse() needed when parse=False
4444

45-
# All vertex data if merged
46-
for name, material in data.materials.items():
45+
# Iterate vertex data collected in each material
46+
for name, material in scene.materials.items():
4747
# Contains the vertex format (string) such as "T2F_N3F_V3F"
4848
# T2F, C3F, N3F and V3F may appear in this string
4949
material.vertex_format
@@ -82,7 +82,7 @@ The `example` directory contains some basic examples using the `visualization` m
8282

8383
* `pyglet_demo.py` : Simple textured globe
8484
* `pyglet_demo2.py` : Higher resolution textured globe
85-
* `pyglet_demo_boxes.py` : Boxes demonstrating supported vertex formats
85+
* `pyglet_demo_boxes.py` : Boxes demonstrating supported vertex formats of the visualization module
8686

8787
### Generating a Wavefront file with Blender
8888

0 commit comments

Comments
 (0)