Skip to content

Commit 88a92c5

Browse files
Update docs.
1 parent 714fc25 commit 88a92c5

File tree

3 files changed

+12
-17
lines changed

3 files changed

+12
-17
lines changed

colour_clf_io/__init__.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
"""
2-
CLF Parsing
3-
===========
2+
Colour - CLF IO
3+
===============
44
55
Defines the functionality and data structures to parse *CLF* files.
66
77
The main functionality is exposed through the following two methods:
8-
- :func:`colour.io.clf.read_clf`: Read a file in the *CLF* format and return the
9-
corresponding :class: ProcessList.
10-
- :func:`colour.io.clf.parse_clf`: Read a string that contains a *CLF* file and
8+
- :func:`colour.io.clf.read_clf_from_file`: Read a file in the *CLF* format and
119
return the corresponding :class: ProcessList.
10+
- :func:`colour.io.clf.read_clf`: Read a string that contains a *CLF* file and
11+
return the corresponding :class: ProcessList.
12+
- :func:`colour.io.clf.write_clf`: Take a :class: ProcessList and output the
13+
corresponding CLF document.
1214
1315
References
1416
----------
@@ -131,7 +133,7 @@ def read_clf_from_file(path: str | Path) -> ProcessList:
131133
If the given file does not contain a valid *CLF* file.
132134
"""
133135

134-
xml = lxml.etree.parse(str(path)) # noqa: S320
136+
xml = lxml.etree.parse(str(path))
135137
xml_process_list = xml.getroot()
136138

137139
process_list = ProcessList.from_xml(xml_process_list)
@@ -161,7 +163,7 @@ def read_clf(text: str | bytes) -> ProcessList | None:
161163
If the given string does not contain a valid *CLF* file.
162164
"""
163165

164-
xml = lxml.etree.fromstring(text) # noqa: S320
166+
xml = lxml.etree.fromstring(text)
165167

166168
return ProcessList.from_xml(xml)
167169

docs/colour_clf_io.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Reading and Writing CLF Files
1212
:toctree: generated/
1313

1414
read_clf
15-
parse_clf
15+
read_clf
16+
write_clf
1617

1718
Process List & Process Nodes
1819
----------------------------

docs/index.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,8 @@ Features
1515
The following features are available:
1616

1717
- Reading *CLF* files to a Python representation.
18-
19-
The following features are planned and in development:
20-
2118
- Writing *CLF* files from the Python representation.
22-
- Validating *CLF* files according to the specification.
23-
24-
Features that will not be part of this library:
25-
26-
- Executing *CLF* workflows and applying them to colours or images. This feature will be implemented as part of `Colour
27-
<https://github.com/colour-science/colour/>`__.
19+
- Executing *CLF* workflows and applying them to colours or images.
2820

2921
Examples
3022
^^^^^^^^

0 commit comments

Comments
 (0)