Version 1.4 #247
Version 1.4 #247
Conversation
…nd changed sections, and update links for version comparison.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #247 +/- ##
=======================================
Coverage 74.38% 74.38%
=======================================
Files 49 49
Lines 2314 2314
Branches 410 410
=======================================
Hits 1721 1721
Misses 502 502
Partials 91 91 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
sadrasabouri
left a comment
sadrasabouri
left a comment
There was a problem hiding this comment.
I left some comments. Also, take a look at the coverage report. It had a warning about the dev (or release) head being ahead, which can be noteworthy.
CHANGELOG.md
Outdated
| ### Added | ||
| ### Changed | ||
| ### Removed | ||
|
|
There was a problem hiding this comment.
We don't need these tags (added, changed, removed) for unreleased when they are empty.
README.md
Outdated
|
|
||
| ⚠️ In order to use `ML streaming` feature, make sure you've installed the `streaming` mode of PyMilo | ||
|
|
||
| ⚠️ **Version compatibility note:** For `ML streaming` over `WebSocket`, please use PyMilo versions `<=1.3`. In version `1.4`, `ML streaming` over `WebSocket` is under construction and not fully functional. For `ML streaming` over `REST`, you can safely use version `1.4` and later. |
There was a problem hiding this comment.
ML Streaming should not be inside backticks (`). The last sentence is also not needed; this note is only for WebSocket, hence for other technologies, PyMilo is expected to work properly over versions.
|
@sadrasabouri Thank you Sadra, for your valuable feedback. Please re-review. |
README.md
Outdated
|
|
||
| ⚠️ In order to use `ML streaming` feature, make sure you've installed the `streaming` mode of PyMilo | ||
|
|
||
| ⚠️ **Version compatibility note:** For ML streaming over `WebSocket`, please use PyMilo versions `<=1.3`. In version `1.4`, `ML streaming` over `WebSocket` is under construction and not fully functional. |
There was a problem hiding this comment.
I suggest saying that this section is under construction and is not stable. It's a bit weird that it refers to a previous version.
There was a problem hiding this comment.
@sepandhaghighi I've updated this part. Could you please check and tell me if it is informative enough?
The reason I went with the previous version was that I wanted to let users safely use v1.4 for REST and only restrict Websocket users to v1.3.
…feature, indicating it is under construction and not yet stable.
Reference Issues/PRs
Release PR of Version 1.4
What does this implement/fix? Explain your changes.
Any other comments?