Language.Nix.Identifier: better organise module documentation #678
Conversation
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
- In general, one should use Identifier and its instances to render and parse Identifiers. quote has been relegated to an Internals section since it is only required by the test suite at the moment. It may be nice to remove it at some point. - needsQuoting deals with arbitrary strings and would normally be used to judge whether a given String should be converted to an Identifier directly or first be subject to some kind of substitution so that it does not need to be quoted (see #672). nixKeywords is an internal definition involved with this which is also used in the test suites.
sternenseemann
force-pushed
the
language-nix-organise
branch
from
9c578f6 to
37dca7c
Compare
|
Not sure why CI started failing for 9.4.8 and under, whether that was introduced with one of the PRs that was recently merged or something else. We probably still care about 9.4.8, given that we have it in Nixpkgs. Should we remove the versions below that from CI? |
wolfgangwalther
approved these changes
Oct 25, 2025
This is due to bad bounds for the new release of crypton-x509-store which has been reported already: kazu-yamamoto/crypton-certificate#21. This should resolve itself when the lower bound on unix is revised for the relevant package version. |
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.
quoteisn't necessary for anything to my knowledge, but used in the test suite. We looks feasible to unexport this. The question is whether it is worth it?needsQuotingis required bydistribution-nixpkgsandhackage2nix(FromCabal.Name: prefix pkg names with _ if they can't be identifiers #672). It is also perfectly fine to exportnixKeywordsisn't necessary to export becauseneedsQuotingaccounts for it. It is nice to have for the test suite and I think it's unproblematic to expose it. Since it's in the Internals section, it should be sufficiently clear that you don't need to manually check against it.parseSimpleIdentifierandparseQuotedIdentifierare promoted in a sense, but usually you'd just useparseMor whatever.