Skip to content

Commit

Permalink
Fix comment/documentation references
Browse files Browse the repository at this point in the history
  • Loading branch information
TravisCardwell committed Jan 9, 2025
1 parent 0e33000 commit 1bc9678
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,13 @@ When hand-writing high-level bindings, there are undoubtedly a lot of patterns
that emerge. We should [capture these as Haskell functions or type
classes](https://github.com/well-typed/hs-bindgen/issues/27) and [release this
as a separate library
`hs-bindgen-patterns`](https://github.com/well-typed/hs-bindgen/issues/28).
`hs-bindgen-runtime`](https://github.com/well-typed/hs-bindgen/issues/28).

### [Milestone 3: High-level API](https://github.com/well-typed/hs-bindgen/milestone/4)

Even in the ideal case that _all_ patterns that are used in the construction
of the high-level bindings can be expressed using the patterns provided by the
`hs-bindgen-patterns` library from milestone 2.5, it might still be cumbersome
`hs-bindgen-runtime` library from milestone 2.5, it might still be cumbersome
to have to write them all out, and so some generation might still be useful.

This is all the more important for data type declarations (as opposed to
Expand All @@ -161,7 +161,7 @@ files themselves, or through using `hs-bindgen` as a library with customizations
as regular Haskell code. It is conceivable that in cases that would require
extensive customization, perhaps the most direct way to do that customization is
not to use generation at all, but simply write bindings manually, provided that
the `hs-bindgen-patterns` library provides sufficient support.
the `hs-bindgen-runtime` library provides sufficient support.

Nonetheless, there will probably be scenarios where a [set of defaults and
heuristics](https://github.com/well-typed/hs-bindgen/issues/32) can do a good
Expand Down
2 changes: 1 addition & 1 deletion hs-bindgen/tests/Orphans.hs
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ instance ToExpr (Hs.TyConAppTy ctx) where
Expr.App "TyConApp" [toExpr tycon, toExpr args]

{-------------------------------------------------------------------------------
hs-bindgen-patterns
hs-bindgen-runtime
-------------------------------------------------------------------------------}

instance ToExpr (SimpleEnum hs)
Expand Down

0 comments on commit 1bc9678

Please sign in to comment.