Skip to content

Commit f8449bb

Browse files
committed
[doc/tutorial] Update section chapter
1 parent ad886c7 commit f8449bb

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

doc/tutorial.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ The Sections
317317
------------
318318

319319
There are several ways to access Sections. You can either call them by name or
320-
by index using either explicitely the function that returns the list of
320+
by index using either explicitly the function that returns the list of
321321
Sections (see last part of `The Document`_ chapter) or using again a short cut
322322
notation. Let's test all the different ways to access a Section, by having a
323323
look at the first Section in the sections list attached to the Document in our
@@ -332,7 +332,7 @@ example odML file::
332332
>>> print(odmlEX[0])
333333
<Section TheCrew[crew] (4)>
334334

335-
In the following we will call Sections explicitely by their name using the
335+
In the following we will call Sections explicitly by their name using the
336336
short cut notation.
337337

338338
The printout of a Section is similar to the Document printout and gives you
@@ -363,9 +363,6 @@ document
363363
attribute is set automatically for a Section and all its children when
364364
it is attached to a Document.
365365

366-
id
367-
- XXXTODOXXX
368-
369366
parent
370367
- Returns the parent to which this Section was directly attached to. Can be
371368
either a Document or another Section.
@@ -384,6 +381,11 @@ repository
384381
terminologies used in this Document. Could be the URL to the G-Node
385382
terminologies or to a user defined template.
386383

384+
id
385+
- id is a UUID (universally unique identifiers) that uniquely identifies
386+
the current section. If not otherwise specified, this id is automatically
387+
created and assigned.
388+
387389
Let's have a look at the attributes for the Section 'TheCrew'::
388390

389391
>>> print(odmlEX['TheCrew'].name)
@@ -392,22 +394,22 @@ Let's have a look at the attributes for the Section 'TheCrew'::
392394
Information on the crew
393395
>>> print(odmlEX['TheCrew'].document)
394396
<Doc 42 by D. N. Adams (2 sections)>
395-
>>> print(sec1.parent)
397+
>>> print(odmlEX['TheCrew'].parent)
396398
<Doc 42 by D. N. Adams (2 sections)>
397-
>>> print(odmlEX['TheCrew'].id)
398-
None
399399
>>> print(odmlEX['TheCrew'].type)
400400
crew
401401
>>> print(odmlEX['TheCrew'].reference)
402402
None
403403
>>> print(odmlEX['TheCrew'].repository)
404404
None
405+
>>> print(odmlEX['TheCrew'].id)
406+
None
405407

406408
As expected for this Section, the name and type attribute match the information
407409
given in the Section printout, and the document and parent attribute return the
408-
same object, namely the our example Document.
410+
same object, namely our example Document.
409411

410-
To see which Sections are directly attached to the Section 'TheCrew' use again
412+
To see which Sections are directly attached to the Section 'TheCrew' again use
411413
the following command::
412414

413415
>>> print(odmlEX['TheCrew'].sections)

0 commit comments

Comments
 (0)