Merge branch 'dash-3.0' into deprecation-removals

Author: T4rk1n

.circleci/config.yml

@@ -540,7 +540,7 @@ jobs:
   table-visual-test:
     working_directory: ~/dash/components/dash-table
     docker:
-      - image: cimg/node:16.13-browsers
+      - image: cimg/node:lts-browsers
         environment:
           PERCY_TOKEN: $PERCY_TOKEN_TABLE
 
@@ -551,7 +551,6 @@ jobs:
       - restore_cache:
           key: dep-{{ .Branch }}-{{ checksum "package-lock.json" }}-{{ checksum "package.json" }}
       - browser-tools/install-browser-tools:
-          chrome-version: 120.0.6099.71
           install-firefox: false
           install-geckodriver: false
       - run:

CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+## [UNRELEASED]
+
+## Fixed
+
+- [#3080](https://github.com/plotly/dash/pull/3080) Fix docstring generation for components using single-line or nonstandard-indent leading comments
+
 ## [2.18.2] - 2024-11-04
 
 ## Fixed
@@ -89,7 +95,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## Fixed
 
 - [#2362](https://github.com/plotly/dash/pull/2362) Global namespace not polluted any more when loading clientside callbacks.
-- [#2833](https://github.com/plotly/dash/pull/2833) Allow data url in link props. Fixes [#2764](https://github.com/plotly/dash/issues/2764) 
+- [#2833](https://github.com/plotly/dash/pull/2833) Allow data url in link props. Fixes [#2764](https://github.com/plotly/dash/issues/2764)
 - [#2822](https://github.com/plotly/dash/pull/2822) Fix side update (running/progress/cancel) dict ids. Fixes [#2111](https://github.com/plotly/dash/issues/2111)
 - [#2817](https://github.com/plotly/dash/pull/2817) Change hashing algorithm from md5 to sha256, Fixes [#2697](https://github.com/plotly/dash/issues/2697).
 - [#2816](https://github.com/plotly/dash/pull/2816) Fix dcc.Dropdown value not updated when option is removed. Fixes [#2733](https://github.com/plotly/dash/issues/2733).
@@ -116,7 +122,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## Added
 - [#2762](https://github.com/plotly/dash/pull/2762) Add dynamic loading of component libraries.
   - Add `dynamic_loading=True` to dash init.
-  - Add `preloaded_libraries=[]` to dash init, included libraries names will be loaded on the index like before. 
+  - Add `preloaded_libraries=[]` to dash init, included libraries names will be loaded on the index like before.
 - [#2758](https://github.com/plotly/dash/pull/2758)
   - exposing `setProps` to `dash_clientside.clientSide_setProps` to allow for JS code to interact directly with the dash eco-system
 - [#2730](https://github.com/plotly/dash/pull/2721) Load script files with `.mjs` ending as js modules

components/dash-core-components/package-lock.json

@@ -5,6 +5,13 @@
 
 
 def get_asset_url(path):
+    """
+    Return the URL for the provided `path` in the assets directory.
+
+    `dash.get_asset_url` is not compatible with Dash Snapshots.
+    Use `get_asset_url` on the app instance instead: `app.get_asset_url`.
+    See `app.get_asset_url` for more information.
+    """
     return app_get_asset_url(CONFIG, path)
 
 
@@ -59,6 +66,9 @@ def display_content(path):
         if page_name == "page-2":
             return chapters.page_2
     ```
+
+    `dash.get_relative_path` is not compatible with Dash Snapshots. Use
+    `get_relative_path` on the app instance instead: `app.get_relative_path`.
     """
     return app_get_relative_path(CONFIG.requests_pathname_prefix, path)
 

components/dash-html-components/package-lock.json

@@ -16,7 +16,7 @@
     "postbuild": "es-check es2015 ../deps/*.js build/*.js",
     "test": "karma start karma.conf.js --single-run",
     "format": "run-s private::format.*",
-    "lint": "run-s private::lint.*"
+    "lint": "run-s private::lint.* --continue-on-error"
   },
   "author": "chriddyp",
   "license": "MIT",

components/dash-table/package-lock.json

@@ -1552,6 +1552,33 @@ def _hash(script):
         ]
 
     def get_asset_url(self, path):
+        """
+        Return the URL for the provided `path` in the assets directory.
+
+        If `assets_external_path` is set, `get_asset_url` returns
+        `assets_external_path` + `assets_url_path` + `path`, where
+        `path` is the path passed to `get_asset_url`.
+
+        Otherwise, `get_asset_url` returns
+        `requests_pathname_prefix` + `assets_url_path` + `path`, where
+        `path` is the path passed to `get_asset_url`.
+
+        Use `get_asset_url` in an app to access assets at the correct location
+        in different environments. In a deployed app on Dash Enterprise,
+        `requests_pathname_prefix` is the app name. For an app called "my-app",
+        `app.get_asset_url("image.png")` would return:
+
+        ```
+        /my-app/assets/image.png
+        ```
+
+        While the same app running locally, without
+        `requests_pathname_prefix` set, would return:
+
+        ```
+        /assets/image.png
+        ```
+        """
         return _get_paths.app_get_asset_url(self.config, path)
 
     def get_relative_path(self, path):

dash/_get_paths.py

@@ -728,7 +728,7 @@ function gatherComponents(sources, components = {}) {
 
             if (propsType) {
                 if (
-                    propsType.valueDeclaration && 
+                    propsType.valueDeclaration &&
                     propsType.valueDeclaration.name &&
                     propsType.valueDeclaration.name.elements &&
                     propsType.valueDeclaration.name.elements.length
@@ -762,7 +762,7 @@ function gatherComponents(sources, components = {}) {
                         fullText
                             .slice(r.pos + 4, r.end - 3)
                             .split('\n')
-                            .map(s => s.slice(3, s.length))
+                            .map(s => s.replace(/^(\s*\*?\s)/, ''))
                             .filter(e => e)
                             .join('\n')
                     )

dash/dash-renderer/package.json

@@ -38,7 +38,7 @@
     "format": "run-s private::format.*",
     "initialize": "run-s private::initialize.*",
     "prepare": "husky install",
-    "lint": "run-s private::lint.*",
+    "lint": "run-s private::lint.* --continue-on-error",
     "setup-tests.py": "run-s private::test.py.deploy-*",
     "setup-tests.R": "run-s private::test.R.deploy-*",
     "citest.integration": "run-s setup-tests.py private::test.integration-*",