Improve formatting of documentation #636
Merged
Conversation
This file contains 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
|
🚀 Deployed on https://deploy-preview-636--etna-docs.netlify.app |
Codecov Report
@@ Coverage Diff @@
## master #636 +/- ##
===========================================
- Coverage 84.32% 52.63% -31.69%
===========================================
Files 118 118
Lines 6263 6264 +1
===========================================
- Hits 5281 3297 -1984
- Misses 982 2967 +1985
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
added 4 commits
April 6, 2022 17:18
martins0n
reviewed
Apr 11, 2022
martins0n
reviewed
Apr 11, 2022
etna/datasets/tsdataset.py
Outdated
| if True with flatten index | ||
| * If False, return pd.DataFrame with multiindex | ||
|
|
||
| * if True, return with flatten index |
There was a problem hiding this comment.
Suggested change
| * if True, return with flatten index | |
| * If True, return with flatten index |
martins0n
reviewed
Apr 11, 2022
etna/loggers/file_logger.py
Outdated
| If `job_type` or `group` isn't set then only one-level subfolder is created. | ||
| If none of `job_type` and `group` is set then experiment logs files into `self.experiment_folder`. | ||
| As a result, within ``self.experiment_folder`` subfolder ``job_type/group`` is created. | ||
| If ``job_type`` or ``group`` isn't set then only one-level subfolder is created. |
There was a problem hiding this comment.
You've added bulletpoints in such cases before
etna/transforms/outliers/base.py
Outdated
| @@ -33,7 +33,7 @@ def _save_original_values(self, ts: TSDataset): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| ts: | |||
| ts: TSDataset | |||
martins0n
reviewed
Apr 11, 2022
etna/analysis/plotters.py
Outdated
| @@ -102,15 +102,19 @@ def plot_forecast( | |||
| ---------- | |||
| forecast_ts: | |||
| there are several options: | |||
|
|
|||
| 1. Forecasted TSDataset with timeseries data, single-forecast mode | |||
There was a problem hiding this comment.
Enumerated points in https://matplotlib.org/sampledoc/cheatsheet.html ?
# Conflicts: # etna/transforms/missing_values/imputation.py
martins0n
approved these changes
Apr 12, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
IMPORTANT: Please do not create a Pull Request without creating an issue first.
Before submitting (must do checklist)
Type of Change
Proposed Changes
Look #631.
Related Issue
#631.
Closing issues
Closes #631.