Cabal package descriptions

I think we need an extra field Synopsis for a short summary of the package, possibly supplemented by the longer Description. This should make Hackage catalogues more readable, and could also be shown by an extended form of hc-pkg list. (repeated) License and License-File should not be mutually exclusive. They're both useful, for different purposes. Perhaps License would be more accurately called License-Type. Perhaps Hidden-Modules should be renamed Other-Modules, now that it is used by both libraries and executables.

Ross Paterson
I think we need an extra field Synopsis for a short summary of the package, possibly supplemented by the longer Description. This should make Hackage catalogues more readable, and could also be shown by an extended form of hc-pkg list.
I think that's a fine idea.
(repeated) License and License-File should not be mutually exclusive. They're both useful, for different purposes. Perhaps License would be more accurately called License-Type.
I would like to make the license field required without being very burdensome to the user; I feel like the license-file field is a bit more burdensome and it's hard for me to justify making it required. Do you still want to have a file as an option in the license-type field? I guess we could make either/or required. What do you think about what should be required?
Perhaps Hidden-Modules should be renamed Other-Modules, now that it is used by both libraries and executables.
Also fine by me. Thanks for the suggestions! peace, isaac

On Thu, Feb 10, 2005 at 07:55:01AM -0800, Isaac Jones wrote:
Ross Paterson
writes: (repeated) License and License-File should not be mutually exclusive. They're both useful, for different purposes. Perhaps License would be more accurately called License-Type.
I would like to make the license field required without being very burdensome to the user; I feel like the license-file field is a bit more burdensome and it's hard for me to justify making it required. Do you still want to have a file as an option in the license-type field?
I guess we could make either/or required. What do you think about what should be required?
I'm not suggesting making License-File required; it's just that now the two fields conflict because they set the same field in the PackageDescription. I've suggesting that License (or Licence-Type) set a field that is an enumeration of constants, and Licence-File set a new FilePath field. I don't don't think either is required now. If you want to make Licence-Type required, I wouldn't mind.

Ross Paterson
On Thu, Feb 10, 2005 at 07:55:01AM -0800, Isaac Jones wrote:
Ross Paterson
writes: (repeated) License and License-File should not be mutually exclusive. They're both useful, for different purposes. Perhaps License would be more accurately called License-Type.
I would like to make the license field required without being very burdensome to the user; I feel like the license-file field is a bit more burdensome and it's hard for me to justify making it required. Do you still want to have a file as an option in the license-type field?
I guess we could make either/or required. What do you think about what should be required?
I'm not suggesting making License-File required; it's just that now the two fields conflict because they set the same field in the PackageDescription. I've suggesting that License (or Licence-Type) set a field that is an enumeration of constants, and Licence-File set a new FilePath field. I don't don't think either is required now. If you want to make Licence-Type required, I wouldn't mind.
That all sounds fine, then. I guess we should take the "OtherLicense" option out of license type, add a licenseFile field, and make either / or required. Is anyone writing all this down? ;) [1] peace, isaac [1] Just kidding, it's going in my ever-growing TODO list.
participants (2)
-
Isaac Jones
-
Ross Paterson