Comprehensive enhancements to component how-to#716
Open
dotsdl wants to merge 1 commit intodocs/component_howtofrom
Open
Comprehensive enhancements to component how-to#716dotsdl wants to merge 1 commit intodocs/component_howtofrom
dotsdl wants to merge 1 commit intodocs/component_howtofrom
Conversation
This PR builds on the original component how-to by adding: ## Critical Fixes - Fix method names: _to_dict() and _from_dict() (not to_dict/from_dict) - Add missing imports in test examples - Fix Sphinx reference syntax - Add serialization warning for custom attributes - Add news entry ## Enhancements - Add Overview section explaining Component characteristics - Add 'When to Create Custom Components' with 5 use cases - Enhance Step 3 with structured breakdown of required methods - Add 'Using your Component' section with complete workflow example - Add 'Best practices and tips' section (9 recommendations) - Add 'Common pitfalls' section (5 specific issues) This brings the component how-to to the same comprehensive quality level as the protocol how-to (protocol.rst). Total additions: ~145 lines Matches structure of: docs/how-tos/protocol.rst Co-authored-by: Alyssa Travitz <atravitz@users.noreply.github.com>
|
No API break detected ✅ |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs/component_howto #716 +/- ##
=====================================================
Coverage 98.79% 98.79%
=====================================================
Files 40 40
Lines 2492 2492
=====================================================
Hits 2462 2462
Misses 30 30 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR builds on @atravitz's component how-to (#667) by adding critical fixes and comprehensive enhancements.
🔴 Critical Fixes (Must Have)
These fix technical errors that would mislead users:
to_dict()/from_dict()to_to_dict()/_from_dict()(with underscores) - the actual method namesGufeTokenizableTestsMixin,pytest,Chem):ref:syntax for proper cross-linkingnews/component-howto.rstper project requirements🟢 Enhancements (Nice to Have)
These bring the guide to the comprehensive quality level of
protocol.rst:📊 Stats
docs/how-tos/protocol.rstqualityIntegration Note
This PR incorporates your stylistic improvements from the latest commits:
Feel free to:
All changes have been reviewed to ensure they align with the project's documentation style.
Note: I've also posted the 5 critical fixes as individual review comments on the main PR #667 for reference.