bb59e7f217
Following up on #20763, this PR adds support for module- and class-level docstrings, adds "additional docstrings" as described in [PEP 257](https://peps.python.org/pep-0257/), and fixes function-level docstrings so that only the first string literal in a function gets treated as a docstring. One question that occurs to me is: Would it be good to capture attribute and additional docstrings differently from regular docstrings? E.g. `@string.doc.attribute`, `@string.doc.additional`? PEP 257 mentions that unlike regular docstrings, these docstrings are ignored by the interpreter (regular docstrings get added as the `__doc__` property of the object they document), so I can see someone potentially wanting to style them a little differently. Release notes: * Added Python syntax highlighting for class- and module-level docstrings, additional docstrings, and improved recognition of function-level docstrings. Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
Zed
Welcome to Zed, a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Installation
On macOS and Linux you can download Zed directly or install Zed via your local package manager.
Other platforms are not yet available:
- Windows (tracking issue)
- Web (tracking issue)
Developing Zed
- Building Zed for macOS
- Building Zed for Linux
- Building Zed for Windows
- Running Collaboration Locally
Contributing
See CONTRIBUTING.md for ways you can contribute to Zed.
Also... we're hiring! Check out our jobs page for open roles.
Licensing
License information for third party dependencies must be correctly provided for CI to pass.
We use cargo-about to automatically comply with open source licenses. If CI is failing, check the following:
- Is it showing a
no license specifiederror for a crate you've created? If so, addpublish = falseunder[package]in your crate's Cargo.toml. - Is the error
failed to satisfy license requirementsfor a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to theacceptedarray inscript/licenses/zed-licenses.toml. - Is
cargo-aboutunable to find the license for a dependency? If so, add a clarification field at the end ofscript/licenses/zed-licenses.toml, as specified in the cargo-about book.