Repository navigation
hash_consing 0.2.1: PlDoc, README and FIXME improvements - #4
Merged
Merged
Conversation
Every %! comment carried its description on the mode line, which PlDoc rejects, so the pack server showed no documentation on any predicate. Each mode line now stands alone and the description follows it. Comments only; the code is unchanged.
…IXME The module comment's FIXME on the order of Ids is deleted; the rule for a file that opts in now says that the standard order of two Ids depends on the history of insertions into the store.
The README and the module comment warn that the rewrite is per file and show one directive file included by every module that hands the terms to another.
The FIXME on an Id written into a clause no longer says the store lives in one thread's global variable: threads that install the loading thread's store read it. The FIXME on a silent trie_lookup/3 failure near a full stack is removed: it was seen once, in another program, and two later probes did not reproduce it.
The README keeps each rewritten/1 directive in a file of its own that every module using the terms includes, and warns that a file that does not include it fails silently. The fixture patterns.pl includes its templates the same way.
The version is 0.2.1: everything since 0.2.0 ships in one release.
Atry
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
One release with every improvement since 0.2.0. The library's code is unchanged; this release changes comments, the README and one test fixture.
Changes
%!comment carried its description on the mode line (%! intern(?Term, ?Id) Id is ...), which PlDoc rejects with "failed to process structured comment". Each mode line now stands alone, and the description follows after a blank comment line. Loaded withdoc_collect(true), the library raises no PlDoc warning, and all seven exports have summaries.test/hash_consing.pltgets the same layout.rewritten/1directive, with theuse_moduleof the library, in a file of its own that every module using the terms includes. It warns that a file which does not include the directive keeps plain terms, so its heads fail to unify with the Ids, silently. The module comment's opt-in paragraph says the same. The fixturepatterns.plnow includespatterns_templates.pl, which the README quotes; its snapshot is unchanged.trie_lookup/3failing silently near a full stack is removed. It was observed once, in another program, before this pack existed, and two later probes did not reproduce it.'__hash_consed_apply/2'(42)still crashes SWI-Prolog 10.0.2 with status 139.version('0.2.1').This replaces #3, which is closed. The branch name says 0.2.2 because 0.2.1 and 0.2.2 were first split into two releases.
Checks
prolog/hash_consing.plis identical to 0.2.0.🤖 Generated with Claude Code