Skip to content

docs(mkdcos): clarify the limitation of quick fix#46

Merged
benbenbang merged 1 commit into
mainfrom
docs/clarify_limitation
Sep 6, 2025
Merged

docs(mkdcos): clarify the limitation of quick fix#46
benbenbang merged 1 commit into
mainfrom
docs/clarify_limitation

Conversation

@benbenbang

Copy link
Copy Markdown
Owner

This pull request updates the documentation to clarify Tombo's recommended workflow and improve guidance on version selection, file format support, and known limitations. The changes help users understand how to best use Tombo in combination with uv/poetry, and provide clear instructions and workarounds for common issues.

Workflow and Usage Guidance

  • Added a clear explanation that Tombo is intended for version research and selection, not automatic insertion, and outlined the recommended workflow for using Tombo with uv or poetry for installing packages.
  • Updated the example workflow in the main documentation to explicitly show that after selecting a version with Tombo, users should run the corresponding uv add command.

Format Support and Known Issues

  • Added a detailed section describing format support levels for PEP 621, Poetry v1, Poetry v2, and requirements.txt, including specific limitations and workarounds for Poetry v2's parentheses format.
  • Expanded troubleshooting documentation to clarify differences between Poetry v1 and v2 formats, with explicit recommendations and examples for each, including manual typing guidance for limited support cases.

Feature Limitations and Recommendations

  • Documented issues with quick fix actions (right-click context menu), including symptoms and recommended usage patterns to avoid formatting problems, and reassured users that improvements are planned.
  • Added a new info block to the main documentation summarizing format support, core features, and linking to troubleshooting for detailed support levels and workarounds.

@benbenbang
benbenbang enabled auto-merge (squash) September 6, 2025 16:27
@github-actions github-actions Bot added documentation Improvements or additions to documentation triage labels Sep 6, 2025
@benbenbang
benbenbang merged commit 99fd6ab into main Sep 6, 2025
2 checks passed
@benbenbang
benbenbang deleted the docs/clarify_limitation branch September 6, 2025 16:27
@ptah-technical-app

Copy link
Copy Markdown

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation released triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant