Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] improved docstring for TrendForecaster and PolynomialTrendForecaster #5747

Merged
merged 2 commits into from Jan 21, 2024
Merged

[DOC] improved docstring for TrendForecaster and PolynomialTrendForecaster #5747

merged 2 commits into from Jan 21, 2024

Conversation

fkiraly
Copy link
Collaborator

@fkiraly fkiraly commented Jan 15, 2024

This PR improves docstrings for TrendForecaster and PolynomialTrendForecaster:

  • attributes listed
  • explained type of regressor_
  • formatting and typos

@fkiraly fkiraly added the documentation Documentation & tutorials label Jan 15, 2024
yarnabrina
yarnabrina previously approved these changes Jan 16, 2024
View reviewed changes
Copy link
Collaborator

@yarnabrina yarnabrina left a comment

Choose a reason for hiding this comment

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

Added a comment, but approved obviously.

Are you making these changes manually, or is there some extension/tool to convert single backticks to double, to add missing sections, etc.?

sktime/forecasting/trend/_polynomial_trend_forecaster.py Outdated Show resolved Hide resolved
@fkiraly
Copy link
Collaborator Author

fkiraly commented Jan 16, 2024

Are you making these changes manually,

Manually - historically, a lot of th docstrings have single ticks only, but "code font" is double ticks in rst, unlike in markdown where it is single tick.

If you know a tool that lints these, that would be very useful.

@fkiraly fkiraly merged commit 79c93dc into main Jan 21, 2024
55 checks passed
@fkiraly fkiraly deleted the trend-docs-improved branch January 21, 2024 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yarnabrina yarnabrina yarnabrina left review comments

@achieveordie achieveordie Awaiting requested review from achieveordie achieveordie is a code owner

@benHeid benHeid Awaiting requested review from benHeid benHeid is a code owner

Assignees
No one assigned
Labels
documentation Documentation & tutorials
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@fkiraly @yarnabrina