From 4b659d7d2dcda49e707a9eb61cb7d9cbfed22c26 Mon Sep 17 00:00:00 2001 From: jCloudBot Date: Sun, 4 Oct 2026 15:19:27 +0000 Subject: [PATCH] chore: update API reference --- .../jcloud_docsgen/core/python/namespaces.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/reference/jcloud_docsgen/core/python/namespaces.md b/docs/reference/jcloud_docsgen/core/python/namespaces.md index ff1c390..9881823 100644 --- a/docs/reference/jcloud_docsgen/core/python/namespaces.md +++ b/docs/reference/jcloud_docsgen/core/python/namespaces.md @@ -1,5 +1,45 @@ # Module `jcloud_docsgen.core.python.namespaces` +## Function `validate_namespace_name` + +Checks whether a namespace name is valid. Namespace names are valid +if they contain no dots and are valid Python identifiers. + +### Function signature + +```python +validate_namespace_name(name: str) -> bool +``` + +### Returns + +Whether the namespace name is valid. + +Return type: `bool` + +### Parameters + +| Parameter | Type | Kind | Default value | Description | +| --- | --- | --- | --- | --- | +| `name` | `str` | normal | -- | The namespace name to validate. | + + + + + + + +### Docstring + +Checks whether a namespace name is valid. Namespace names are valid +if they contain no dots and are valid Python identifiers. + +:param name: The namespace name to validate. +:type name: str + +:returns: Whether the namespace name is valid. +:rtype: bool + ## Class `PythonNamespace` The base class for all Python namespaces such as modules or packages. @@ -57,6 +97,8 @@ The base class for all Python namespaces such as modules or packages. :param name: The name of the namespace. :type name: str +:raises InvalidNamespaceError: If the namespace name is invalid. + ## Class `PythonPackageNamespace` A subclass of ``PythonNamespace`` for Python package namespaces. @@ -381,6 +423,8 @@ A subclass of ``PythonNamespace`` for Python package namespaces. :param sub_namespaces: The sub-namespaces. :type sub_namespaces: list[PythonNamespace] +:raises InvalidNamespaceError: If the namespace name is invalid. + ## Class `PythonModuleNamespace` A subclass of ``PythonNamespace`` for Python module namespaces.