docs: fix DatetimeOrdinal user guide and api documentation#899
Open
ankitlade12 wants to merge 1 commit intofeature-engine:mainfrom
Open
docs: fix DatetimeOrdinal user guide and api documentation#899ankitlade12 wants to merge 1 commit intofeature-engine:mainfrom
ankitlade12 wants to merge 1 commit intofeature-engine:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #899 +/- ##
=======================================
Coverage 98.27% 98.27%
=======================================
Files 116 116
Lines 4978 4978
Branches 795 795
=======================================
Hits 4892 4892
Misses 55 55
Partials 31 31 ☔ 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.
Fix DatetimeOrdinal User Guide and API Documentation (#898)
Description
Resolves issue #898 where the
DatetimeOrdinaluser guide was incorrectly displaying API information.Changes
.. autoclass::directive that was inadvertently injecting the API spec into the main user guide text. Added an explanation detailing why converting datetime features into ordinal variables is useful for machine learning models (i.e., preserving relative temporal distances while dropping formatting complexities)... automodule::to.. autoclass:: feature_engine.datetime.DatetimeOrdinalto correctly surface the transformer methods and documentation in the proper location.Checklist
blackandisortflake8andmypyand the build passespytestlocally