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

Improve docs #212

Merged
merged 7 commits into from
Jan 27, 2025
Merged

Improve docs #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f59e4c5
Correct table format
samer-hamood Dec 30, 2024
4c0c3f7
Use single-line JSON label for code block
samer-hamood Jan 8, 2025
19cc581
Make grammar consistent, add punctuation and generally fix language a…
samer-hamood Jan 8, 2025
52ab9e3
Make language used more uniformly consistent, structured and accurate…
samer-hamood Jan 25, 2025
ef2b2f3
Link file references to files
samer-hamood Jan 14, 2025
c9e0bb3
Format names of function parameters
samer-hamood Jan 14, 2025
9900615
Add language improvements to CHANGELOG.md
samer-hamood Jan 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 35 additions & 28 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,50 +1,57 @@
# Changelog

## Release 1.6

- Corrected and improved language consistency in [readme](README.md) and `CHANGELOG.md`

## Release 1.5

## Release 1.4

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

## Release 1.3.0

- added precompute attribute to reverse transformation (#137)
- Update setup.py dill to requirements.txt (#138)
- Added precompute attribute to reverse transformation (#137)
- Updated setup.py dill to requirements.txt (#138)
- Docstring of tail fixed (#140)
- adding extend feature (#144)
- Added extend feature (#144)

## Release 1.2.0

- Fix Broken link in readme
- Loosen version requirements #129
- Fix lint errors
- Fix StopIteration errors for Python 3.7 #132
- Drop support for python 3.4
- Fixed Broken link in readme
- Loosened version requirements #129
- Fixed lint errors
- Fixed StopIteration errors for Python 3.7 #132
- Dropped support for python 3.4

## Release 1.1.3

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

## Release 1.1.0

- Implemented optimized version of `reduce_by_key`
- Implemented `count_by_key`
- Implemented `count_by_value`
- Implemented `accumulate` https://github.com/EntilZha/PyFunctional/pull/104
- Fix bug in `grouped` https://github.com/EntilZha/PyFunctional/pull/123
- Fix bug in `to_csv` https://github.com/EntilZha/PyFunctional/pull/123
- Fix bug with incorrect wrapping of pandas dataframes https://github.com/EntilZha/PyFunctional/pull/122
- Allow variance on versions of certain packages: https://github.com/EntilZha/PyFunctional/pull/117 and https://github.com/EntilZha/PyFunctional/pull/116
- Added support for variance on versions of certain packages: https://github.com/EntilZha/PyFunctional/pull/117 and https://github.com/EntilZha/PyFunctional/pull/116
- Various typo fixes
- Various CI fixes
- Fix issue with `first/head` evaluating entire sequence https://github.com/EntilZha/PyFunctional/commit/fb8f3686cf94f072f4e6ed23a361952de1447dc8
- Drop CI testing and official support for Python 3.3
- Make import much faster by loading pandas more lazily https://github.com/EntilZha/PyFunctional/issues/99
- Dropped CI testing and official support for Python 3.3
- Made import much faster by loading pandas more lazily https://github.com/EntilZha/PyFunctional/issues/99

### Bug Fixes

- Fixed bug in `grouped` https://github.com/EntilZha/PyFunctional/pull/123
- Fixed bug in `to_csv` https://github.com/EntilZha/PyFunctional/pull/123
- Fixed bug with incorrect wrapping of pandas dataframes https://github.com/EntilZha/PyFunctional/pull/122
- Fixed issue with `first/head` evaluating entire sequence https://github.com/EntilZha/PyFunctional/commit/fb8f3686cf94f072f4e6ed23a361952de1447dc8

## Release 1.0.0

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

### New Features

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

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

### Bug Fixes

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

## Release 0.7.0

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

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

## Release 0.6.0

### New Features

- Added support for reading to and from SQLite databases
- Change project name to `PyFunctional` from `ScalaFunctional`
- Changed project name from `ScalaFunctional` to `PyFunctional`
- Added `to_pandas` call integration

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

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

## Release 0.4.1

Fix python 3 build error due to wheel installation of enum34. Package no longer depends on enum34
Fixed python 3 build error due to wheel installation of enum34. Package no longer depends on enum34

## Release 0.4.0

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

### Bug Fixes
Expand Down
Loading
Loading