Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"customizations": {
"vscode": {
"extensions": [
"rust-lang.rust-analyzer",
"rust-lang.rust-analyzer"
]
},
"settings": {
Expand Down
4 changes: 2 additions & 2 deletions .githooks/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ echo "--- Format ---"
cargo fmt --all
echo "OK"

echo "--- Clippy fix ---"
cargo clippy --all-targets --fix --allow-dirty --allow-staged -- -D warnings
echo "--- Clippy check ---"
cargo clippy --all-targets -- -D warnings
echo "OK"

echo "--- Stage fixed files ---"
Expand Down
22 changes: 6 additions & 16 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# pydocstringについて
- pydocstringはPythonのdocstringをパースするライブラリです
- pydocstringはNumPy/Googleスタイルをサポートします
- 将来的にリンタやフォーマッタで使用されることを想定しています
- Rustで実装します
- Rustの外部クレートは使用しません

# 実装方針
- NumPy->Googleの順で実装します
- リンタ向けにパース結果には位置情報を含めます
- 設計方針はBiomeを参考にします
- 内部実装はスタイルごとに具体的な構造体を定義します
- 公開APIは抽象化された構造体を返すようにします

# docstringのスタイルガイド
- NumPy: https://numpydoc.readthedocs.io/en/latest/format.html
# About pydocstring
- Parses Python docstrings
- Supports NumPy and Google style docstrings
- Designed to be used by linters and formatters
- Implemented in Rust
- No external crate dependencies
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[package]
name = "pydocstring"
version = "0.0.1"
version = "0.0.2"
edition = "2024"
authors = ["Ryuma Asai"]
description = "A fast, zero-dependency Rust parser for Python docstrings (NumPy and Google styles) with full AST and source location tracking"
description = "A zero-dependency Rust parser for Python docstrings (Google and NumPy styles) with a unified syntax tree and byte-precise source locations"
license = "MIT"
repository = "https://github.com/qraqras/pydocstring"
homepage = "https://github.com/qraqras/pydocstring"
documentation = "https://docs.rs/pydocstring"
readme = "README.md"
keywords = ["python", "docstring", "parser", "numpy", "google"]
keywords = ["python", "docstring", "parser", "google", "numpy"]
categories = ["parser-implementations", "development-tools"]
rust-version = "1.85"
exclude = ["target/", "tests/", ".github/", ".devcontainer/"]
Expand Down
Loading