Skip to content

vz update deprecated#14

Open
vickimzhang wants to merge 3 commits intomasterfrom
vz-update-deprecated
Open

vz update deprecated#14
vickimzhang wants to merge 3 commits intomasterfrom
vz-update-deprecated

Conversation

@vickimzhang
Copy link
Member

@vickimzhang vickimzhang commented Nov 27, 2025

Update the README and the home page with a warning that stsimsf is now deprecated as it has been integrated with st-sim for SyncroSim 3.

Summary by CodeRabbit

  • Documentation
    • Added a deprecation notice: stsimsf is deprecated for SyncroSim 3; stocks/flows functionality is now integrated with ST-Sim. The notice has been added to user-facing documentation (placed before requirements) to guide users to the integrated workflow.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Nov 27, 2025

Walkthrough

Added deprecation notices to user documentation stating that stsimsf is deprecated with SyncroSim 3 and that stocks/flows functionality is integrated into ST‑Sim. No functional code or public API changes were made.

Changes

Cohort / File(s) Summary
Deprecation documentation
README.md, docs/index.md
Appended deprecation notices indicating stsimsf is deprecated for SyncroSim 3 and that stocks and flows are now integrated with ST‑Sim; no code or API changes.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'vz update deprecated' is vague and does not clearly convey the main change—adding deprecation notices to documentation. Consider using a more descriptive title such as 'Add deprecation notice to README and documentation' to better reflect the actual changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch vz-update-deprecated

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d486e8c and 3956a0f.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 50b7339 and d486e8c.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • docs/index.md (1 hunks)
🔇 Additional comments (1)
docs/index.md (1)

20-21: Avis de dépréciation bien placé et cohérent.

Le message de dépréciation est clairement communicé et placé stratégiquement avant la section Exigences. La cohérence du message avec le fichier README.md est appropriée.

@vickimzhang vickimzhang requested a review from katieb1 November 27, 2025 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant