Glossary

[gilch]

Closes #264. I still need to clean up use of terminology in the wiki, but the glossary should enable that. I'm not certain the documentation is using the terminology correctly either, but I should be able to correct that as well when I reread it.

The glossary clarified some concepts, and I've aligned the reader (and other modules) to reflect that. It resulted in some refactoring/streamlining and renaming.

The prelude no longer imports reduce and partial from functools. The new ~~reader macros~~ tags /#, /XY#, and &# should compensate in most cases. They are, of course, still available in the standard library if you need them, under the slightly longer functools.- fully-qualified names.

[gilch]

I deleted the glossary wiki page. The new documentation page supersedes it and it's out of date.

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 83.89831% with 19 lines in your changes missing coverage. Please review.

Project coverage is 90.71%. Comparing base (dddc0b1) to head (6b252d6). Report is 62 commits behind head on master.

Files with missing lines	Patch %	Lines
src/hissp/compiler.py	80.64%	15 Missing and 3 partials :warning:
src/hissp/__init__.py	85.71%	1 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #265      +/-   ##
==========================================
- Coverage   93.29%   90.71%   -2.59%     
==========================================
  Files           6        5       -1     
  Lines         805      506     -299     
  Branches      126       78      -48     
==========================================
- Hits          751      459     -292     
+ Misses         49       44       -5     
+ Partials        5        3       -2     

Flag	Coverage Δ
	90.71% <83.89%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[gilch]

Closes #256 as well. I didn't want to change that before the next release, but considering the magnitude of the other changes I'm making, it seemed silly to keep putting it off.

[gilch]

OK. I feel like I need to sync this one up.

It's still not ready for a release and it looks like it's not going to make it before October, so next release will target Python 3.10. I should be able to clean up some logic with the new match statement, but no rush if it's not broken. Not a blocker.

The Whirlwind Tour still needs a rewrite, so I haven't updated usage of terms there yet. I'll try to make it more concise, hopefully without making it hard to follow. The macro tutorial lost a major section (the last one about slicing), but only because I plan on writing some new sections that should cover the same concepts, and then some.

I've added features that need test coverage, which is slipping. The new tutorial sections should help, but anything not covered in the doc examples will need a proper unit test.

The hissp..refresh# and hissp..subrepl# tags seem particularly difficult to test (which is why I've resisted adding this kind of thing), but some of my testing machinery already in place can probably be made to do it. Not sure about the EOF though.

Robust testing for alias and prelude standalone regressions (the latter happened) appear to be impossible in a single environment. I'd have to script the creation of a new venv without the hissp package installed to test the compiled output. A GitHub Workflow can theoretically do this kind of thing, but I won't be adding it to the normal unit test suite. I'm not considering this one a blocker for the next release.

Clarifying terminology has brought some things to light. I've made several changes to the code, not just the documentation.