Skip to content

Commit 15cf058

Browse files
authored
clarify usage caveats for loadRecord (#58)
1 parent f96e177 commit 15cf058

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

ns1/__init__.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,12 @@ def loadRecord(
294294
Load an existing record into a high level Record object.
295295
296296
:param str domain: domain name of the record in the zone, for example \
297-
'myrecord'. You may leave off the zone, since it must be \
298-
specified in the zone parameter
297+
'myrecord'. You may leave off the zone, if it is specified in the \
298+
zone parameter. This is recommended. You can pass a fully \
299+
qualified domain and not pass the zone argument, but this will \
300+
not work as expected if there are any dots in the domain, e.g. \
301+
`foo.example.com` is OK, `foo.bar.example.com` will not work as
302+
expected.
299303
:param str type: record type, such as 'A', 'MX', 'AAAA', etc.
300304
:param str zone: zone name, like 'example.com'
301305
:rtype: :py:class:`ns1.records`

0 commit comments

Comments
 (0)