doc/api: regenerate notes

There seem to be a difference between API notes in different files: some
contain CRLF, some LF only, and also some empty lines are present while
they should not be there.

Normalize the remaining API docs.

Signed-off-by: Alexander Bokovoy <abokovoy@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
Reviewed-By: David Hanina <dhanina@redhat.com>
This commit is contained in:
Alexander Bokovoy authored and Sudhir Menon committed 2025-10-28 17:57:43 +05:30
1 parent b94848ccff
commit 3bb87c2684
64 files changed
+64 -128

No files matched your search

+1 -2
View File
@@ -3,5 +3,4 @@
# A6Record
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A6 DNS record.
A6 DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# AAAARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
AAAA DNS record.
AAAA DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# AFSDBRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
AFSDB DNS record.
AFSDB DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# APLRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
APL DNS record.
APL DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# ARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A DNS record.
A DNS record.
+1 -2
View File
@@ -3,7 +3,6 @@
# AccessTime
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Access time parameter type.
Accepts values conforming to generalizedTime as defined in RFC 4517 section 3.3.13 without time zone information.
Accepts values conforming to generalizedTime as defined in RFC 4517 section 3.3.13 without time zone information.
+1 -2
View File
@@ -3,5 +3,4 @@
# Any
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter capable of holding values of any type. For internal use only.
A parameter capable of holding values of any type. For internal use only.
+1 -2
View File
@@ -3,5 +3,4 @@
# BinaryFile
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Binary file parameter type.
Binary file parameter type.
+1 -2
View File
@@ -3,5 +3,4 @@
# Bool
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for boolean values (stored in the ``bool`` type).
A parameter for boolean values (stored in the ``bool`` type).
+1 -2
View File
@@ -3,9 +3,8 @@
# Bytes
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for binary data (stored in the ``str`` type).
This class is named *Bytes* instead of *Str* so it's aligned with the
Python v3 ``(str, unicode) => (bytes, str)`` clean-up.
See: http://docs.python.org/3.0/whatsnew/3.0.html
Also see the `Str` parameter.
Also see the `Str` parameter.
+1 -2
View File
@@ -3,5 +3,4 @@
# BytesEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Enumerable for binary data (stored in the ``str`` type).
Enumerable for binary data (stored in the ``str`` type).
+1 -2
View File
@@ -3,5 +3,4 @@
# CERTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
CERT DNS record.
CERT DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# CNAMERecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
CNAME DNS record.
CNAME DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# DHCIDRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DHCID DNS record.
DHCID DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# DLVRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DLV DNS record.
DLV DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# DNAMERecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DNAME DNS record.
DNAME DNS record.
+1 -2
View File
@@ -3,7 +3,6 @@
# DNOrURL
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DN parameter that allows, and strips, a "ldap:///" prefix on input.
Used for ``subtree`` to maintain backward compatibility.
Used for ``subtree`` to maintain backward compatibility.
+1 -2
View File
@@ -3,5 +3,4 @@
# DNParam
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
LDAP DN.
LDAP DN.
+1 -2
View File
@@ -3,8 +3,7 @@
# DNSNameParam
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Domain name parameter type.
* `only_absolute`: a domain name has to be absolute (makes it absolute from unicode input)
* `only_relative`: a domain name has to be relative
* `only_relative`: a domain name has to be relative
+1 -2
View File
@@ -3,5 +3,4 @@
# DNSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for DNS records, subclass of `Str`.
Base class for DNS records, subclass of `Str`.
+1 -2
View File
@@ -3,5 +3,4 @@
# DSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DS DNS record.
DS DNS record.
+1 -2
View File
@@ -3,9 +3,8 @@
# Data
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for the `Bytes` and `Str` parameters.
Previously `Str` was as subclass of `Bytes`. Now the common functionality
has been split into this base class so that ``isinstance(foo, Bytes)`` wont
be ``True`` when ``foo`` is actually an `Str` instance (which is confusing).
be ``True`` when ``foo`` is actually an `Str` instance (which is confusing).
+1 -2
View File
@@ -3,7 +3,6 @@
# DateTime
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DateTime parameter type.
Accepts LDAP Generalized time without in the following format:
@@ -16,4 +15,4 @@ Accepts subset of values defined by ISO 8601:
Also accepts above formats using ' ' (space) as a separator instead of 'T'.
Refer to the `man strftime` for the explanations for the %Y,%m,%d,%H.%M,%S.
Refer to the `man strftime` for the explanations for the %Y,%m,%d,%H.%M,%S.
+1 -2
View File
@@ -3,10 +3,9 @@
# Decimal
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for floating-point values (stored in the ``Decimal`` type).
Python Decimal type helps overcome problems tied to plain "float" type,
e.g. problem with representation or value comparison. In order to safely
transfer the value over RPC libraries, it is being converted to string
which is then converted back to Decimal number.
which is then converted back to Decimal number.
+1 -2
View File
@@ -3,5 +3,4 @@
# Dict
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for dictionary.
A parameter for dictionary.
+1 -2
View File
@@ -3,5 +3,4 @@
# Enum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for parameters with enumerable values.
Base class for parameters with enumerable values.
+1 -2
View File
@@ -3,7 +3,6 @@
# File
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Text file parameter type.
Accepts file names and loads their content into the parameter value.
Accepts file names and loads their content into the parameter value.
+1 -2
View File
@@ -3,7 +3,6 @@
# Flag
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A boolean parameter that always gets filled in with a default value.
This `Bool` subclass forces ``autofill=True`` in `Flag.__init__()`. If no
@@ -34,4 +33,4 @@ no effect. For example:
>>> flag = Flag('my_flag', autofill=False)
>>> flag.autofill
True
```
```
+1 -2
View File
@@ -3,5 +3,4 @@
# ForwardRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Forward DNS record.
Forward DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# HINFORecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
HINFO DNS record.
HINFO DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# HIPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
HIP DNS record.
HIP DNS record.
+1 -2
View File
@@ -3,9 +3,8 @@
# HostPassword
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A data type for host passwords to not log password values.
The `Password` type cannot be used because it disallows
setting a password on the command-line which would break
backwards compatibility.
backwards compatibility.
+1 -2
View File
@@ -3,5 +3,4 @@
# IA5Str
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
An IA5String per RFC 4517.
An IA5String per RFC 4517.
+1 -2
View File
@@ -3,5 +3,4 @@
# IPSECKEYRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
IPSECKEY DNS record.
IPSECKEY DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# Int
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for integer values (stored in the ``int`` type).
A parameter for integer values (stored in the ``int`` type).
+1 -2
View File
@@ -3,5 +3,4 @@
# IntEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Enumerable for integer data (stored in the ``int`` type).
Enumerable for integer data (stored in the ``int`` type).
+1 -2
View File
@@ -3,5 +3,4 @@
# KEYRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
KEY DNS record.
KEY DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# KXRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
KX DNS record.
KX DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# LOCRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
LOC DNS record.
LOC DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# MDRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
MD DNS record.
MD DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# MINFORecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
MINFO DNS record.
MINFO DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# MXRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
MX DNS record.
MX DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# NAPTRRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NAPTR DNS record.
NAPTR DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# NSECRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NSEC DNS record.
NSEC DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# NSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NS DNS record.
NS DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# NXTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NXT DNS record.
NXT DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# Number
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for the `Int` and `Decimal` parameters.
Base class for the `Int` and `Decimal` parameters.
+1 -2
View File
@@ -3,5 +3,4 @@
# OTPTokenKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A binary password type specified in base32.
A binary password type specified in base32.
+1 -2
View File
@@ -3,5 +3,4 @@
# PTRRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
PTR DNS record.
PTR DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# Password
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for passwords (stored in the ``unicode`` type).
A parameter for passwords (stored in the ``unicode`` type).
+1 -2
View File
@@ -3,5 +3,4 @@
# Principal
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Kerberos principal name.
Kerberos principal name.
+1 -2
View File
@@ -3,5 +3,4 @@
# RPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
RP DNS record.
RP DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# RRSIGRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
RRSIG DNS record.
RRSIG DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# SIGRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SIG DNS record.
SIG DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# SPFRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SPF DNS record.
SPF DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# SRVRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SRV DNS record.
SRV DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# SSHFPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SSHFP DNS record.
SSHFP DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# SerialNumber
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Certificate serial number parameter type.
Certificate serial number parameter type.
+1 -2
View File
@@ -3,7 +3,6 @@
# Str
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for Unicode text (stored in the ``unicode`` type).
This class is named `Str` instead of `Unicode` so it's aligned with the
@@ -11,4 +10,4 @@ Python v3 ``(str, unicode) => (bytes, str)`` clean-up.
See: http://docs.python.org/3.0/whatsnew/3.0.html
Also see the `Bytes` parameter.
Also see the `Bytes` parameter.
+1 -2
View File
@@ -3,7 +3,6 @@
# StrEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Enumerable for Unicode text (stored in the ``unicode`` type).
For example:
@@ -16,4 +15,4 @@ True
Traceback (most recent call last):
...
ValidationError: invalid 'my_enum': must be one of 'One', 'Two', 'Three'
```
```
+1 -2
View File
@@ -3,5 +3,4 @@
# TLSARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
TLSA DNS record.
TLSA DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# TXTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
TXT DNS record.
TXT DNS record.
+1 -2
View File
@@ -3,5 +3,4 @@
# URIRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
URI DNS record.
URI DNS record.
+1 -2
View File
@@ -3,6 +3,5 @@
# UnsupportedDNSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Records which are not supported by IPA, but we allow to show them if LDAP
contains these records.
contains these records.