From c49585498a6ada3d191e1f0eb5b9b6ae0d7cc1fb Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 13 Jan 2025 20:09:14 +0000 Subject: [PATCH] [pre-commit.ci] pre-commit autoupdate (#826) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [pre-commit.ci] pre-commit autoupdate updates: - [github.com/astral-sh/ruff-pre-commit: v0.8.6 → v0.9.1](https://github.com/astral-sh/ruff-pre-commit/compare/v0.8.6...v0.9.1) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix docs --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Luca Marconato --- .pre-commit-config.yaml | 2 +- docs/contributing.md | 2 ++ src/spatialdata/_core/spatialdata.py | 7 +++---- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 65e24914..bdcf7763 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -27,7 +27,7 @@ repos: additional_dependencies: [numpy, types-requests] exclude: tests/|docs/ - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.8.6 + rev: v0.9.1 hooks: - id: ruff args: [--fix, --exit-non-zero-on-fix] diff --git a/docs/contributing.md b/docs/contributing.md index 937a3ad7..a4fff419 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -129,6 +129,7 @@ We recommend using the button "Generate release notes" to automatically collect The release notes serve as a changelog for the user of the package so it's important to have them curated and well-organized. This is explained in depth below. Here is an example of automatically generated release notes for a previous release (v0.2.3): + ``` ## What's Changed * Add clip parameter to polygon_query; tests missing by @LucaMarconato in https://github.com/scverse/spatialdata/pull/670 @@ -172,6 +173,7 @@ The release notes above can be hard to read, but this is addressed by our [confi Use informative titles for PRs, as these will serve as section titles in the release notes (rename the PRs if necessary). You can also manually edit the release notes before publishing them to improve readability. Some additional considerations + - Important! If a PR is large and its title isn't informative or requires multiple lines, **do not** add a release tag. Instead, in the first message of the PR discussion, please include a markdown section with a brief description of the intended release notes. This will allow the person making a release to manually add the PR content to the release notes during the release process. - Please avoid redundancy and do not add the same release notes to consecutive pre-releases/releases/post-releases. - When automatically generating the release notes, you can use the button "Previous tag: ..." to choose which PRs will be included in the release notes. diff --git a/src/spatialdata/_core/spatialdata.py b/src/spatialdata/_core/spatialdata.py index 75d739db..0fe70dc4 100644 --- a/src/spatialdata/_core/spatialdata.py +++ b/src/spatialdata/_core/spatialdata.py @@ -1680,10 +1680,9 @@ def get_attrs( Returns ------- - dict[str, Any] | str | pd.DataFrame - The data associated with the specified key, returned in the specified format. - The format can be a dictionary, JSON string, or Pandas DataFrame, depending on - the value of `return_as`. + The data associated with the specified key, returned in the specified format. + The format can be a dictionary, JSON string, or Pandas DataFrame, depending on + the value of `return_as`. """ def _flatten_mapping(m: Mapping[str, Any], parent_key: str = "", sep: str = "_") -> dict[str, Any]: