Skip to content

Commit 7ae9698

Browse files
committed
[base/section] Docstring updates
1 parent aa73267 commit 7ae9698

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

odml/base.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -660,17 +660,17 @@ def create_section(self, name=None, type="n.s.", oid=None, definition=None,
660660
Creates a new subsection that is a child of this section.
661661
662662
:param name: The name of the section to create. If the name is not
663-
provided, the uuid of the Property is assigned as its name.
664-
Section name is a required attribute.
663+
provided, the object id of the Section is assigned as its name.
664+
Section name is a required attribute.
665665
:param type: String providing a grouping description for similar Sections.
666666
Section type is a required attribute and will be set to the string
667667
'n.s.' by default.
668668
:param oid: object id, UUID string as specified in RFC 4122. If no id
669669
is provided, an id will be generated and assigned.
670-
:param definition: String describing the definition of the Section.
670+
:param definition: String defining this Section.
671671
:param reference: A reference (e.g. an URL) to an external definition
672672
of the Section.
673-
:param repository: URL to a repository where this Section can be found.
673+
:param repository: URL to a repository in which the Section is defined.
674674
:param link: Specifies a soft link, i.e. a path within the document.
675675
:param include: Specifies an arbitrary URL. Can only be used if *link* is not set.
676676

odml/section.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ class BaseSection(base.Sectionable):
2626
An odML Section.
2727
2828
:param name: string providing the name of the Section. If the name is not
29-
provided, the uuid of the Property is assigned as its name.
29+
provided, the object id of the Section is assigned as its name.
3030
Section name is a required attribute.
3131
:param type: String providing a grouping description for similar Sections.
3232
Section type is a required attribute and will be set to the string
3333
'n.s.' by default.
3434
:param parent: the parent object of the new Section. If the object is not
3535
an odml.Section or an odml.Document, a ValueError is raised.
36-
:param definition: String describing the definition of the Section.
36+
:param definition: String defining this Section.
3737
:param reference: A reference (e.g. an URL) to an external definition
3838
of the Section.
39-
:param repository: URL to a repository where this Section can be found.
39+
:param repository: URL to a repository in which the Section is defined.
4040
:param link: Specifies a soft link, i.e. a path within the document.
4141
:param include: Specifies an arbitrary URL. Can only be used if *link* is not set.
4242
:param oid: object id, UUID string as specified in RFC 4122. If no id is provided,

0 commit comments

Comments
 (0)