#346: Add a warning for synopsis being a prefix of the description ----------------------------+----------------------------------------------- Reporter: guest | Owner: Type: defect | Status: new Priority: normal | Milestone: Component: Cabal library | Version: HEAD Severity: normal | Resolution: Keywords: | Difficulty: normal Ghcversion: 6.8.2 | Platform: ----------------------------+----------------------------------------------- Comment (by guest): This makes certain packages on Hoogle look fairly silly by listing the same text twice. I am loathe to fix this in Hoogle, as its really a bug in each package, and hilighting it might get it fixed. -- Neil -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/346#comment:1 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#346: Add a warning for synopsis being a prefix of the description ----------------------------+----------------------------------------------- Reporter: guest | Owner: Type: defect | Status: new Priority: normal | Milestone: Component: Cabal library | Version: HEAD Severity: normal | Resolution: Keywords: | Difficulty: normal Ghcversion: 6.8.2 | Platform: ----------------------------+----------------------------------------------- Comment (by guest): I thought the description wasn't meant to replicate the summary, but checking the Cabal manual I can't actually see that guideline. So what is the recommended ruling? Should the description stand alone without the summary? Should they be both shown if you want to display more? Could the Cabal manual make a ruling on this, so at least I can follow whatever guidelines are proposed. My personal view is that the Description should not restate the summary, but be a fresh description of the package, which makes sense without the summary. However, when displaying the description the summary should always be displayed as well. This is pretty much the same idea as Abstract(Summary) and Introduction(Description) in a paper. -- Neil (who wonders how to get a hackage trac account...) -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/346#comment:3 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects

#346: Add a warning for synopsis being a prefix of the description ----------------------------+----------------------------------------------- Reporter: guest | Owner: Type: defect | Status: new Priority: normal | Milestone: Component: Cabal library | Version: HEAD Severity: normal | Resolution: Keywords: | Difficulty: easy (<4 hours) Ghcversion: 6.8.2 | Platform: ----------------------------+----------------------------------------------- Changes (by duncan): * difficulty: normal => easy (<4 hours) Comment: Ok, lets update the documentation to give better guidance. Note that `cabal list` presents only synopsis while `cabal info` presents both synopsis and description, though not directly next to each other. It's like: {{{ * bytestring-csv (library) Synopsis: Parse CSV formatted data efficiently Latest version available: 0.1.2 Latest version installed: [ Not installed ] Homepage: http://code.haskell.org/~dons/code/bytestring-csv Bug reports: [ Not specified ] Description: Parse CSV formatted data efficiently Category: Data License: BSD3 ... etc }}} We could add a warning if one is a prefix of the other but that's only going to catch exact literal prefixes, not trivial variations. Also sometimes the natural thing is to make it a prefix but with an extended sentence like: {{{ synopsis: A library for doing blah description: A library for doing blah with blah blah blah and more blah. }}} We can check if they are exactly equal though. Or what about if the common prefix ends in a '.' ie end of sentence? I think it'd take a little experimentation to find a test that makes a suggestion only for the cases we want without upsetting legit uses. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/346#comment:5 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects