tashirosota/ex-r_enum

💎Enum extended with convenient functions inspired by Ruby and Rails ActiveSupport.

ex-r_enum's Issues

Maybe hide some implementation details?

It is a matter of design decision. So it is just an idea.

Currently the library exposes all the implementation details. I have a feeling that what users want is the top-level module and its functions. If we hide all the potentially-private modules, the documentation could be simpler. Then we can explain about each of the top-level functions in their @doc.

In other words, do the users need to know about REnum.Native, REnum.Ruby, etc?

Ruby's Array and ActiveSupport has many difficult methods.

It's a difficult implementation, so I'd be happy if someone could cut it out and implement it...
https://qiita.com/shshimamo/items/5a458ecc88e7c24d5112
Please create a PR for here

usage image

Maybe skip implementing Ruby `Array#zip`?

Implementing List zip is a bit tricky!
Maybe we could skip it unless we really want what Ruby exactly does 🤔

Notes

• Elixir has very flexible and powerful functions for zipping lists; all named zip or zip_*
• Ruby zip behaves slightly different; when list lengths are not the same, nil is padded for shorter lists
• Ruby's zip accept variable arguments; it accepts any argument length

Some related docs

• https://hexdocs.pm/elixir/List.html#zip/1
• https://hexdocs.pm/elixir/1.13/Enum.html#zip/2
• https://hexdocs.pm/elixir/1.13/Enum.html#zip_reduce/2
• https://hexdocs.pm/elixir/1.13/Enum.html#zip_with/2
• https://apidock.com/ruby/Array/zip
• https://apidock.com/ruby/Array/transpose

TODO: Contribution Guide

TODO: Introductory article written in English.

Why not just use `Enum.to_list/1` for `REnum.to_a/1`?

Is there a particular reason why key-value pairs need to be lists?

hexdocsの目次から各関数へジャンプできない

REnumのhexdocの目次に書かれているリンク先と、実際の各項目ごとのリンクが異なっているようです。
hexdocs: https://hexdocs.pm/r_enum/readme.html

・目次のリンク: https://hexdocs.pm/r_enum/readme.html#compact1
・各項目のリンク: https://hexdocs.pm/r_enum/readme.html#compact-1