Skip to content

Commit 07ff9cd

Browse files
authored
Improve docs (#212)
* Correct table format * Use single-line JSON label for code block * Make grammar consistent, add punctuation and generally fix language a bit * Make language used more uniformly consistent, structured and accurate and correct some spelling, grammar and punctuation * Link file references to files * Format names of function parameters * Add language improvements to CHANGELOG.md
1 parent d1b6479 commit 07ff9cd

File tree

2 files changed

+69
-62
lines changed

2 files changed

+69
-62
lines changed

CHANGELOG.md

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,57 @@
11
# Changelog
22

3+
## Release 1.6
4+
5+
- Corrected and improved language consistency in [readme](README.md) and `CHANGELOG.md`
6+
37
## Release 1.5
48

59
## Release 1.4
610

7-
- Allow empty sequence expressions `seq()`, `pseq()` (#159)
8-
- Add `no_wrap` option to `head()`, `head_option()`, `first()`, `last()` and `last_option()`, as well as to `seq()`, `pseq()` and `Sequence` constructor
11+
- Added support for empty sequence expressions `seq()`, `pseq()` (#159)
12+
- Added `no_wrap` option to `head()`, `head_option()`, `first()`, `last()` and `last_option()`, as well as to `seq()`, `pseq()` and `Sequence` constructor
913

1014
## Release 1.3.0
1115

12-
- added precompute attribute to reverse transformation (#137)
13-
- Update setup.py dill to requirements.txt (#138)
16+
- Added precompute attribute to reverse transformation (#137)
17+
- Updated setup.py dill to requirements.txt (#138)
1418
- Docstring of tail fixed (#140)
15-
- adding extend feature (#144)
19+
- Added extend feature (#144)
1620

1721
## Release 1.2.0
1822

19-
- Fix Broken link in readme
20-
- Loosen version requirements #129
21-
- Fix lint errors
22-
- Fix StopIteration errors for Python 3.7 #132
23-
- Drop support for python 3.4
23+
- Fixed Broken link in readme
24+
- Loosened version requirements #129
25+
- Fixed lint errors
26+
- Fixed StopIteration errors for Python 3.7 #132
27+
- Dropped support for python 3.4
2428

2529
## Release 1.1.3
2630

27-
- Fix bug in `partition` https://github.com/EntilZha/PyFunctional/issues/124
31+
- Fixed bug in `partition` https://github.com/EntilZha/PyFunctional/issues/124
2832

2933
## Release 1.1.0
3034

3135
- Implemented optimized version of `reduce_by_key`
3236
- Implemented `count_by_key`
3337
- Implemented `count_by_value`
3438
- Implemented `accumulate` https://github.com/EntilZha/PyFunctional/pull/104
35-
- Fix bug in `grouped` https://github.com/EntilZha/PyFunctional/pull/123
36-
- Fix bug in `to_csv` https://github.com/EntilZha/PyFunctional/pull/123
37-
- Fix bug with incorrect wrapping of pandas dataframes https://github.com/EntilZha/PyFunctional/pull/122
38-
- Allow variance on versions of certain packages: https://github.com/EntilZha/PyFunctional/pull/117 and https://github.com/EntilZha/PyFunctional/pull/116
39+
- Added support for variance on versions of certain packages: https://github.com/EntilZha/PyFunctional/pull/117 and https://github.com/EntilZha/PyFunctional/pull/116
3940
- Various typo fixes
4041
- Various CI fixes
41-
- Fix issue with `first/head` evaluating entire sequence https://github.com/EntilZha/PyFunctional/commit/fb8f3686cf94f072f4e6ed23a361952de1447dc8
42-
- Drop CI testing and official support for Python 3.3
43-
- Make import much faster by loading pandas more lazily https://github.com/EntilZha/PyFunctional/issues/99
42+
- Dropped CI testing and official support for Python 3.3
43+
- Made import much faster by loading pandas more lazily https://github.com/EntilZha/PyFunctional/issues/99
44+
45+
### Bug Fixes
46+
47+
- Fixed bug in `grouped` https://github.com/EntilZha/PyFunctional/pull/123
48+
- Fixed bug in `to_csv` https://github.com/EntilZha/PyFunctional/pull/123
49+
- Fixed bug with incorrect wrapping of pandas dataframes https://github.com/EntilZha/PyFunctional/pull/122
50+
- Fixed issue with `first/head` evaluating entire sequence https://github.com/EntilZha/PyFunctional/commit/fb8f3686cf94f072f4e6ed23a361952de1447dc8
4451

4552
## Release 1.0.0
4653

47-
Reaching `1.0` primarily means that API stability has been reached so I don't expect to run into many new breaking changes.
54+
Reaching `1.0` primarily means that API stability has been reached, so I don't expect to run into many new breaking changes.
4855

4956
### New Features
5057

@@ -67,13 +74,13 @@ Reaching `1.0` primarily means that API stability has been reached so I don't ex
6774

6875
- Implemented pretty html repr for Jupyter
6976
- Implemented proper parsing of pandas DataFrames
70-
- Detect when its possible to pretty print a table and do so
77+
- Added feature to detect when it's possible to pretty print a table and do so
7178
- `list`/`to_list` have a parameter `n` to limit number of results
7279

7380
### Bug Fixes
7481

7582
- Fixed bug where `grouped` unnecessarily forces precomputation of sequence
76-
- Remove package installations from default requirements that sometimes break installation on barebones systems in python 2.7
83+
- Removed package installations from default requirements that sometimes break installation on barebones systems in python 2.7
7784

7885
## Release 0.7.0
7986

@@ -96,14 +103,14 @@ Reaching `1.0` primarily means that API stability has been reached so I don't ex
96103
### Contributors
97104

98105
- Thanks to [versae](https://github.com/versae) for implementing most of the `pseq` feature!
99-
- Thanks to [ChuyuHsu](https://github.com/ChuyuHsu) for implemented large parts of the compression feature!
106+
- Thanks to [ChuyuHsu](https://github.com/ChuyuHsu) for implementing large parts of the compression feature!
100107

101108
## Release 0.6.0
102109

103110
### New Features
104111

105112
- Added support for reading to and from SQLite databases
106-
- Change project name to `PyFunctional` from `ScalaFunctional`
113+
- Changed project name from `ScalaFunctional` to `PyFunctional`
107114
- Added `to_pandas` call integration
108115

109116
### Internal Changes
@@ -125,13 +132,13 @@ Reaching `1.0` primarily means that API stability has been reached so I don't ex
125132

126133
- Fixed case where `_wrap` is changing named tuples to arrays when it should preserve them
127134
- Fixed documentation on `to_file` which incorrectly copied from `seq.open` delimiter parameter
128-
- Fixed `Sequence.zip_with_index` behavior. used to mimic `enumerate` by zipping on the left size
129-
while scala and spark do zip on the right side. This introduces different behavior and more flexible
130-
behavior in combination with `enumerate` A start parameter was also added like in `enumerate`
135+
- Fixed `Sequence.zip_with_index` behavior, which used to mimic `enumerate` by zipping on the left side
136+
while Scala and Spark zip on the right side. This introduces different but more flexible
137+
behavior in combination with `enumerate`. A start parameter was also added like in `enumerate`
131138

132139
## Release 0.4.1
133140

134-
Fix python 3 build error due to wheel installation of enum34. Package no longer depends on enum34
141+
Fixed python 3 build error due to wheel installation of enum34. Package no longer depends on enum34
135142

136143
## Release 0.4.0
137144

@@ -156,7 +163,7 @@ Fix python 3 build error due to wheel installation of enum34. Package no longer
156163
- `Sequence.to_file` to save files
157164
- `Sequence.to_csv` to save csv files
158165
- Improved documentation with more examples and mention LINQ explicitly
159-
- Change PyPi keywords to improve discoverability
166+
- Changed PyPi keywords to improve discoverability
160167
- Created [Google groups mailing list](https://groups.google.com/forum/#!forum/scalafunctional)
161168

162169
### Bug Fixes

0 commit comments

Comments
 (0)