1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

Documentation cleanup

This commit is contained in:
jeremystretch
2022-07-11 17:29:25 -04:00
parent 2264937f81
commit 1ddb219a0c
9 changed files with 45 additions and 11 deletions

View File

@@ -31,7 +31,7 @@ def get_snapshots(instance, action):
'postchange': None,
}
if action != ObjectChangeActionChoices.ACTION_DELETE:
# Use model's serialize() method if defined; fall back to serialize_object
# Use model's serialize_object() method if defined; fall back to serialize_object() utility function
if hasattr(instance, 'serialize_object'):
snapshots['postchange'] = instance.serialize_object()
else:

View File

@@ -72,7 +72,8 @@ class ObjectView(BaseObjectView):
class ObjectChildrenView(ObjectView, ActionsMixin, TableMixin):
"""
Display a table of child objects associated with the parent object.
Display a table of child objects associated with the parent object. For example, NetBox uses this to display
the set of child IP addresses within a parent prefix.
Attributes:
child_model: The model class which represents the child objects

View File

@@ -106,7 +106,7 @@ class TokenForm(BootstrapMixin, forms.ModelForm):
required=False,
label='Allowed IPs',
help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. '
'Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"',
'Example: <code>10.1.1.0/24,192.168.10.16/32,2001:db8:1::/64</code>',
)
class Meta: