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

Jump to bottom

Rework: documentation #114

Open
oscbyspro opened this issue Oct 13, 2024 · 0 comments
Open

Rework: documentation #114

oscbyspro opened this issue Oct 13, 2024 · 0 comments
Labels
documentation scribbles n' doodles!

Comments

@oscbyspro
Copy link
Owner

oscbyspro commented Oct 13, 2024 •
edited
Loading

Working on this project has given me some new insights. In particular, I'm not convinced that documenting things on a per-module basis scales well. I'll rewrite the documentation when I find the time to do so. An introduction, installation, and points-of-interests section might be better, where the latter is just a place to highlight particular behaviors and things you can do with the project—holistically.
@oscbyspro oscbyspro added the documentation scribbles n' doodles! label Oct 13, 2024
oscbyspro added a commit that referenced this issue Oct 17, 2024
@oscbyspro
Baseline rework of README (#114).
5b72738 
I'm taking a more holistic approch this time around.
oscbyspro added a commit that referenced this issue Oct 17, 2024
@oscbyspro
The Fallible<T> redemption arc (#114).
71cb7d4
oscbyspro added a commit that referenced this issue Oct 17, 2024
@oscbyspro
Cleanup of documentation (#114).
1b3d702
oscbyspro added a commit that referenced this issue Oct 19, 2024
@oscbyspro
The abstract symphony and fallible expectations (#114).
1ac7c2b
oscbyspro added a commit that referenced this issue Oct 19, 2024
@oscbyspro
Cleanup (#114).
dec4a2a
oscbyspro added a commit that referenced this issue Oct 21, 2024
@oscbyspro
Add a section about destructuring (#114).
e50bfd0
oscbyspro added a commit that referenced this issue Oct 22, 2024
@oscbyspro
The lossy invariant (#114).
017c1aa
oscbyspro added a commit that referenced this issue Oct 24, 2024
@oscbyspro
Reinstate binary integer quadrants (#114).
5f13a8e
oscbyspro added a commit that referenced this issue Nov 15, 2024
@oscbyspro
Write binary integer description section (#114).
ee14792
oscbyspro added a commit that referenced this issue Dec 16, 2024
@oscbyspro
The magic Divider<T> constants README.md section (#114).
770c0d4 
This patch also introduces a 2-by-1 convenience method to natural integers.
oscbyspro added a commit that referenced this issue Dec 18, 2024
@oscbyspro
The arbitrary bit Count unification README.md section (#114).
da908fb
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation scribbles n' doodles!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@oscbyspro