RomanNum3ral
/
netbox
mirror of https://github.com/netbox-community/netbox.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes #22195: Align continuation-line indentation in attrs.py docstrings (#22196) 

Bump under-indented continuation lines in the Parameters sections of
RelatedObjectAttr, GenericForeignKeyAttr, and AddressAttr so griffe's
Google parser (used by zensical) no longer warns about confusing
indentation. Whitespace-only change; no rendered output differs.
This commit is contained in:
Martin Hauser 2026-05-14 15:36:32 +02:00 committed by GitHub
parent d124c5fe86
commit 71d0352a7c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
netbox/netbox/ui/attrs.py
View File

@ -274,7 +274,7 @@ class RelatedObjectAttr(ObjectAttribute):
Parameters:
linkify (bool): If True, the rendered value will be hyperlinked to the related object's detail view
grouped_by (str): A second-order object to annotate alongside the related object; for example, an attribute
representing the dcim.Site model might specify grouped_by="region"
representing the dcim.Site model might specify grouped_by="region"
colored (bool): If True, render the object as a colored badge when it exposes a `color` attribute
"""
template_name = 'ui/attrs/object.html'
@ -412,13 +412,13 @@ class GenericForeignKeyAttr(ObjectAttribute):
Parameters:
linkify (bool): If True, the rendered value will be hyperlinked
to the related object's detail view.
to the related object's detail view.
nested (bool): If True and the related object exposes a callable
`get_ancestors(include_self=True)`, render the object together
with its ancestors as a breadcrumb, similar to `NestedObjectAttr`.
Non-hierarchical objects continue to render normally.
`get_ancestors(include_self=True)`, render the object together
with its ancestors as a breadcrumb, similar to `NestedObjectAttr`.
Non-hierarchical objects continue to render normally.
max_depth (int): Maximum number of ancestors to display when
`nested` is enabled. Ignored otherwise.
`nested` is enabled. Ignored otherwise.
"""
template_name = 'ui/attrs/generic_object.html'
@ -463,7 +463,7 @@ class AddressAttr(MapURLMixin, ObjectAttribute):
Parameters:
map_url (bool/str): The URL to use when rendering the address. If True, the address will render as a
hyperlink using settings.MAPS_URL.
hyperlink using settings.MAPS_URL.
"""
template_name = 'ui/attrs/address.html'