Skip to content

docs: correct built-in style lookup example #1557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Mirochill wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −4
Draft

docs: correct built-in style lookup example #1557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/api/enum/WdBuiltinStyle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ Specifies a built-in Microsoft Word style.
Example::

from docx import Document
from docx.enum.style import WD_STYLE

document = Document()
styles = document.styles
style = styles[WD_STYLE.BODY_TEXT]
style = styles["Body Text"]

A built-in style must be defined in the document before it can be looked up.
Style lookup uses the style's English UI name, e.g. ``"Body Text"``; a
``WD_STYLE`` member like ``WD_STYLE.BODY_TEXT`` is not a style lookup key.

----

Expand Down
7 changes: 5 additions & 2 deletions src/docx/enum/style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ class WD_BUILTIN_STYLE(BaseEnum):
Example::

from docx import Document
from docx.enum.style import WD_STYLE

document = Document()
styles = document.styles
style = styles[WD_STYLE.BODY_TEXT]
style = styles["Body Text"]

A built-in style must be defined in the document before it can be looked
up. Style lookup uses the style's English UI name, e.g. ``"Body Text"``;
a ``WD_STYLE`` member like ``WD_STYLE.BODY_TEXT`` is not a style lookup
key.

MS API name: `WdBuiltinStyle`

Expand Down