Doc update for hz_sophia and hz_aaci and some minor fixes #30

2026-05-26T09:41:39+09:00

zxq9 commented

2026-05-26 09:41:39 +09:00

No description provided.

zxq9 added 9 commits 2026-05-26 09:41:40 +09:00

Correct keyblock() type e595991616

Merge branch 'master' into docs 9fd8dbd1a6

Fill in the holes in hz.erl docs and make hz_fetcher.erl eaccd50764

Doc update f8e9333b4b

Adjust error condition a3b19747b6

Document hz_aaci types 3fae9a2edd

Fix dialyzer warnings for hz_aaci 8bc79d3b3f

A while ago I tried dialyzer and discovered that actually a lot of the AACI generation process
never fails, and whatever the one failure was that was possible, I think I decided was unnecessary,
and made that produce {ok, unknown_type} instead. I then set the types of these functions to be
{ok, Result} | {error, none()}, since there were in fact no errors, but dialyzer still spewed out
warnings for all the case blocks that redundantly check for these impossible error conditions.

Anyway now that is fixed! The behavior and external interface are all the same still, there are just fewer warnings
now.

Also added specs for a couple more internal functions, just because.
So noperhaps realized that actually none of it should fail. I never went in and
removed all the {ok, _} wrappers, but I did at least type the functions with the correct error list

Document hz_aaci functions 23c13f607e

Once the types were documented, the functions were easy to document. Just say "see erlang_expr/0 for details" over and over! ;p

Add type information for hz_sophia 9fc89c0c22

This one was much simpler to do than hz_aaci, since it doesn't introduce any new types.

I could have made note of some of the conventions, where a type can be represented in multiple
ways in Sophia syntax, or where these functions are actually more lenient than the compiler, but
it isn't as easy to break those notes up from the basic function usage, like it was in hz_aaci,
where those aforementioned new types are used.

zxq9 merged commit 3585dbe534 into master

2026-05-26 09:44:53 +09:00

zxq9 deleted branch spivee/docs

2026-05-26 09:44:54 +09:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: QPQ-AG/hakuzaru#30