Enable numpydoc and use it consistently

doc/conf.py

@@ -86,6 +86,7 @@
 
 
 extensions = [
+    'numpydoc',
     'bokeh.sphinxext.bokeh_plot',
     'myst_parser',
     'sphinx_design',

panel/auth.py

@@ -124,8 +124,8 @@ async def get_authenticated_user(self, redirect_uri, client_id, state,
         """
         Fetches the authenticated user
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         redirect_uri: (str)
           The OAuth redirect URI
         client_id: (str)
@@ -172,8 +172,8 @@ async def _fetch_access_token(
         """
         Fetches the access token.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         client_id:
           The client ID
         redirect_uri:

panel/chat/feed.py

@@ -659,8 +659,8 @@ def send(
 
         If `respond` is `True`, additionally executes the callback, if provided.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         value : ChatMessage | dict | Any
             The message contents to send.
         user : str | None
@@ -711,8 +711,8 @@ def stream(
         This method is primarily for outputs that are not generators--
         notably LangChain. For most cases, use the send method instead.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         value : str | dict | ChatMessage
             The new token value to stream.
         user : str | None
@@ -781,8 +781,8 @@ def add_step(
         Adds a ChatStep component either by appending it to an existing
         ChatMessage or creating a new ChatMessage.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         step : str | list(str) | ChatStep | None
             The objects to stream to the step.
         append : bool
@@ -889,8 +889,8 @@ def prompt_user(
         """
         Prompts the user to interact with a form component.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         component : Widget | ListPanel
             The component to prompt the user with.
         callback : Callable
@@ -1092,8 +1092,8 @@ def serialize(
         """
         Exports the chat log.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         format : str
             The format to export the chat log as; currently only
             supports "transformers".
@@ -1155,8 +1155,8 @@ def select(self, selector=None):
         Iterates over the ChatInterface and any potential children in the
         applying the selector.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         selector: type or callable or None
           The selector allows selecting a subset of Viewables by
           declaring a type or callable function to filter by.

panel/chat/interface.py

@@ -583,8 +583,8 @@ def active(self, index: int) -> None:
         """
         Set the active input widget tab index.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         index : int
             The active index to set.
         """
@@ -602,8 +602,8 @@ def _serialize_for_transformers(
         """
         Exports the chat log for use with transformers.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         messages : list(ChatMessage)
             A list of ChatMessage objects to serialize.
         role_names : dict(str, str | list(str)) | None
@@ -668,8 +668,8 @@ def send(
 
         If `respond` is `True`, additionally executes the callback, if provided.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         value : ChatMessage | dict | Any
             The message contents to send.
         user : str | None
@@ -714,8 +714,8 @@ def stream(
         This method is primarily for outputs that are not generators--
         notably LangChain. For most cases, use the send method instead.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         value : str | dict | ChatMessage
             The new token value to stream.
         user : str | None

panel/chat/message.py

@@ -684,8 +684,8 @@ def stream(self, token: str, replace: bool = False):
         in a layout of `Column(Markdown(...), Image(...))` the Markdown
         pane is updated.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         token: str
           The token to stream to the text pane.
         replace: bool (default=False)
@@ -702,8 +702,8 @@ def update(
         """
         Updates the message with a new value, user and avatar.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         value : ChatMessage | dict | Any
             The message contents to send.
         user : str | None
@@ -747,8 +747,8 @@ def serialize(
         """
         Format the object to a string.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         prefix_with_viewable_label : bool
             Whether to include the name of the Viewable, or type
             of the viewable if no name is specified.

panel/chat/step.py

@@ -242,8 +242,8 @@ def stream(self, token: str | None, replace: bool = False):
         """
         Stream a token to the last available string-like object.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         token : str
             The token to stream.
         replace : bool
@@ -276,8 +276,8 @@ def serialize(
         """
         Format the object to a string.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         prefix_with_viewable_label : bool
             Whether to include the name of the Viewable, or type
             of the viewable if no name is specified.

panel/custom.py

@@ -538,8 +538,8 @@ def _handle_msg(self, data: Any) -> None:
         Message handler for messages sent from the frontend using the
         `model.send_msg` API.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         data: any
             Data received from the frontend.
         """
@@ -549,8 +549,8 @@ def _send_msg(self, data: Any) -> None:
         Sends data to the frontend which can be observed on the frontend
         with the `model.on_msg("msg:custom", callback)` API.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         data: any
             Data to send to the frontend.
         """
@@ -561,8 +561,8 @@ def on_msg(self, callback: Callable) -> None:
         Registers a callback to be executed when a message event
         containing arbitrary data is received.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         event: str
           Name of the DOM event to add an event listener to.
         callback: callable
@@ -575,8 +575,8 @@ def on_event(self, event: str, callback: Callable) -> None:
         Registers a callback to be executed when the specified DOM
         event is triggered.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         event: str
           Name of the DOM event to add an event listener to.
         callback: callable
@@ -780,8 +780,8 @@ def send(self, msg: dict):
         """
         Sends a custom event containing the provided message to the frontend.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         msg: dict
         """
         self._send_msg(msg)

panel/io/handlers.py

@@ -598,8 +598,8 @@ def _render_template(self, doc, path):
         found in the notebook and lays them out according to the
         cell metadata (if present).
 
-        Arguments
-        ----------
+        Parameters
+        -----------
         doc (Document)
             A ``Document`` to render the template into
         path (str):
@@ -676,8 +676,8 @@ def unset_reset():
     def modify_document(self, doc: Document) -> None:
         """Run Bokeh application code to update a ``Document``
 
-        Arguments
-        ----------
+        Parameters
+        -----------
         doc (Document) : a ``Document`` to update
         """
         path = self._runner._path

panel/io/location.py

@@ -233,8 +233,8 @@ def sync(
         parameters in the URL. If no parameters are supplied all
         parameters except the name are synced.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         parameterized (param.Parameterized):
           The Parameterized object to sync query parameters with
         parameters (list or dict):
@@ -273,8 +273,8 @@ def unsync(self, parameterized: param.Parameterized, parameters: list[str] | Non
         params in the URL. If no parameters are supplied all
         parameters except the name are unsynced.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         parameterized (param.Parameterized):
           The Parameterized object to unsync query parameters with
         parameters (list):

panel/io/resources.py

@@ -538,8 +538,8 @@ def resolve_resources(
         """
         Resolves the resources required for this component.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         cdn: bool | Literal['auto']
             Whether to load resources from CDN or local server. If set
             to 'auto' value will be automatically determine based on