📝 Add docstrings to docs/mkdocs-site

[coderabbitai]

Docstrings generation was requested by @petems.

• feat: package server and add mkdocs documentation site #41 (comment)

The following files were modified:

• src/mcp_github_pr_review_spec_maker/cli.py
• src/mcp_github_pr_review_spec_maker/server.py
• tests/test_enterprise_url_support.py
• tests/test_git_pr_resolver.py
• tests/test_mcp_server_tools.py
• tests/test_rest_error_handling.py

These files were kept as they were

• tests/conftest.py
• tests/test_config_edge_cases.py
• tests/test_integration.py
• tests/test_status_fields.py

These file types are not supported

• AGENTS.md
• CLAUDE.md
• README.md
• UV_COMMANDS.md
• docs/architecture/overview.md
• docs/changelog.md
• docs/contributing/index.md
• docs/getting-started/configuration.md
• docs/getting-started/installation.md
• docs/getting-started/quickstart.md
• docs/guides/editor-integrations.md
• docs/guides/local-stdio.md
• docs/guides/remote-uv-endpoint.md
• docs/index.md
• docs/reference/cli.md
• docs/reference/environment.md
• docs/reference/mcp-manifest.md
• docs/reference/publishing.md
• docs/reference/tools.md
• docs/security/index.md
• mkdocs.yml
• prompts/GITHUB_API_ROBUSTNESS.md
• pyproject.toml
• requirements.txt
• specs/PHASE2_ENTERPRISE_GITHUB_URLS.md
• src/mcp_github_pr_review_spec_maker/mcp.json

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[coderabbitai]

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[petems]

@coderabbitai run the ruff linter on these changes and then commit

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Run ruff linter on the modified files
echo "=== Running ruff check on modified files ==="
ruff check src/mcp_github_pr_review_spec_maker/cli.py \
  src/mcp_github_pr_review_spec_maker/server.py \
  tests/test_enterprise_url_support.py \
  tests/test_git_pr_resolver.py \
  tests/test_mcp_server_tools.py \
  tests/test_rest_error_handling.py

echo ""
echo "=== Running ruff format check on modified files ==="
ruff format --check src/mcp_github_pr_review_spec_maker/cli.py \
  src/mcp_github_pr_review_spec_maker/server.py \
  tests/test_enterprise_url_support.py \
  tests/test_git_pr_resolver.py \
  tests/test_mcp_server_tools.py \
  tests/test_rest_error_handling.py

Length of output: 83971

---

@petems I've run the ruff linter on the changes and found several issues that need to be fixed. However, I cannot commit code directly to the repository, even when requested.

Issues Found

Ruff Check: 138 errors (137 remaining)

• E501 (Line too long): 128+ lines exceed the 88-character limit
• E101 (Mixed indentation): Several lines contain mixed spaces and tabs

Ruff Format: All 6 modified files need reformatting

How to Fix

You can fix these issues by running the following commands locally:

# Auto-fix formatting issues
ruff format src/mcp_github_pr_review_spec_maker/cli.py \
  src/mcp_github_pr_review_spec_maker/server.py \
  tests/test_enterprise_url_support.py \
  tests/test_git_pr_resolver.py \
  tests/test_mcp_server_tools.py \
  tests/test_rest_error_handling.py

# Check for any remaining issues
ruff check --fix src/mcp_github_pr_review_spec_maker/cli.py \
  src/mcp_github_pr_review_spec_maker/server.py \
  tests/test_enterprise_url_support.py \
  tests/test_git_pr_resolver.py \
  tests/test_mcp_server_tools.py \
  tests/test_rest_error_handling.py

# Then commit the changes
git add -u
git commit -m "Fix ruff linting issues"
git push

The main issues are long docstring lines that need to be wrapped to stay within the 88-character limit, and some mixed spaces/tabs in indentation that ruff format will automatically fix.