packages feed

ronn 1.1.1.0 → 1.1.2.0

raw patch · 3 files changed

+12/−3 lines, 3 filesPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

API changes (from Hackage documentation)

- Ronn.AST: [$sel:content:Definition] :: Definition -> Maybe [Content]
- Ronn.AST: [$sel:content:Section] :: Section -> [Content]
- Ronn.AST: [$sel:description:Definition] :: Definition -> Line
- Ronn.AST: [$sel:description:Ronn] :: Ronn -> [Part]
- Ronn.AST: [$sel:name:Definition] :: Definition -> Part
- Ronn.AST: [$sel:name:ManRef] :: ManRef -> Text
- Ronn.AST: [$sel:name:Ronn] :: Ronn -> ManRef
- Ronn.AST: [$sel:name:Section] :: Section -> Text
- Ronn.AST: [$sel:section:ManRef] :: ManRef -> ManSection
- Ronn.AST: [$sel:sections:Ronn] :: Ronn -> [Section]
- Ronn.AST: [$sel:unwrap:Line] :: Line -> [Part]
- Ronn.ManRef: [$sel:name:ManRef] :: ManRef -> Text
- Ronn.ManRef: [$sel:section:ManRef] :: ManRef -> ManSection
+ Ronn: getCmdDefinitions :: forall (a :: k). HasSections p => p a -> Maybe [Definition]
+ Ronn.AST: [content] :: Definition -> Maybe [Content]
+ Ronn.AST: [description] :: Definition -> Line
+ Ronn.AST: [name] :: ManRef -> Text
+ Ronn.AST: [section] :: ManRef -> ManSection
+ Ronn.AST: [sections] :: Ronn -> [Section]
+ Ronn.AST: [unwrap] :: Line -> [Part]
+ Ronn.ManRef: [name] :: ManRef -> Text
+ Ronn.ManRef: [section] :: ManRef -> ManSection
- Ronn: class HasSections p
+ Ronn: class HasSections (p :: k -> Type)
- Ronn: getEnvDefinitions :: HasSections p => p a -> Maybe [Definition]
+ Ronn: getEnvDefinitions :: forall (a :: k). HasSections p => p a -> Maybe [Definition]
- Ronn: getOptDefinitions :: HasSections p => p a -> Maybe [Definition]
+ Ronn: getOptDefinitions :: forall (a :: k). HasSections p => p a -> Maybe [Definition]
- Ronn: getSections :: HasSections p => Text -> p a -> [Section]
+ Ronn: getSections :: forall {k} p (a :: k). HasSections p => Text -> p a -> [Section]
- Ronn: getSynopsis :: HasSections p => p a -> Maybe [Part]
+ Ronn: getSynopsis :: forall (a :: k). HasSections p => p a -> Maybe [Part]

Files

CHANGELOG.md view
@@ -1,10 +1,14 @@ ## [_Unreleased_](https://github.com/pbrisbin/ronn/compare/ronn-v1.1.1.0...main) -## [v1.1.1.0](https://github.com/pbrisbin/ronn/tree/ronn-v1.1.1.0)+## [v1.1.2.0](https://github.com/pbrisbin/ronn/compare/ronn-v1.1.1.0...ronn-v1.1.2.0) +- Add `getCmdSections` to `HasSections` to support `# COMMANDS`++## [v1.1.1.0](https://github.com/pbrisbin/ronn/compare/ronn-v1.1.0.0...ronn-v1.1.1.0)+ - Add `HasSections` and `getSections` -## [v1.1.0.0](https://github.com/pbrisbin/ronn/tree/ronn-v1.1.0.0)+## [v1.1.0.0](https://github.com/pbrisbin/ronn/compare/ronn-v1.0.0.0...ronn-v1.1.0.0)  - Export more `...ToText` functions - Strengthen `ManRef` types
ronn.cabal view
@@ -1,6 +1,6 @@ cabal-version:   1.18 name:            ronn-version:         1.1.1.0+version:         1.1.2.0 license:         AGPL-3 maintainer:      Pat Brisbin homepage:        https://github.com/pbrisbin/ronn#readme
src/Ronn.hs view
@@ -47,6 +47,10 @@   getOptDefinitions :: p a -> Maybe [Definition]   getOptDefinitions _ = Nothing +  -- | Options parsers should produce a list of command/help definitions+  getCmdDefinitions :: p a -> Maybe [Definition]+  getCmdDefinitions _ = Nothing+   -- | Environment parsers should produce a list of variable/help definitions   getEnvDefinitions :: p a -> Maybe [Definition]   getEnvDefinitions _ = Nothing@@ -56,6 +60,7 @@   catMaybes     [ synopsisSection name <$> getSynopsis p     , definitionsSection "OPTIONS" <$> getOptDefinitions p+    , definitionsSection "COMMANDS" <$> getCmdDefinitions p     , definitionsSection "ENVIRONMENT" <$> getEnvDefinitions p     ]