Add a lazy is_sorted function to collections

[clintval]

No description provided.

[codecov]

Codecov Report

Attention: Patch coverage is 94.44444% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.44%. Comparing base (fbe5923) to head (9eadbdf).

Files	Patch %	Lines
fgpyo/collections/__init__.py	94.44%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #159      +/-   ##
==========================================
+ Coverage   88.38%   88.44%   +0.06%     
==========================================
  Files          16       16              
  Lines        1773     1791      +18     
  Branches      377      381       +4     
==========================================
+ Hits         1567     1584      +17     
  Misses        136      136              
- Partials       70       71       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nh13]

Is it appropriate for this type be "private" when it is used as a type parameter in a "public" method below?

[clintval]

Can do!

I notice fgpyo doesn't use __init__.py for public namespace definition which makes defining a public API trickier. For example, the function pairwise in this PR is now exposed as our public API instead of just as an import or a helper. I do see Matt is tracking that issue here, though:

• Move code out of __init__.py and into {submodule}.py files #136

EDIT: I renamed pairwise to _pairwise to avoid this without the need to restructure the project.

[nh13]

Agreed, one way to manage what is public versus private is #136, but another way to solve it is to the way we're doing here. Moving things out of __init__.py into submodules doesn't solve this, since the methods/classes can be public there, but it does help with namespace issues. Lets move that discussion to #136 since the namespace issue is compelling, and any new method can always be private like we have here for pairwise.

[nh13]

lgtm

[clintval]

Now all example code blocks are code-colored too!