Pharo Issue Tracker - Manuscript (Case [Issue]21617) Kernel - Better implementation of package comments

Manuscript Notification

	Denis Kudryashov opened Case 21617: Better implementation of package comments and assigned it to Everyone: Enhancement in Kernel: 1. Pharo Image • You are subscribed to this case

Now package comment is managed as class side method #description of package manifest class.
I suggest to change it to use comment of manifest class itself.
So
aPackage comment = APackageManifest comment

It have few advantages:

- it is simpler in implementation.
No need to build method body from String. Notice that current #packageComment: method is broken because it for not work with arbitrary string. The Nautilus (only users of package comment) pass formatted string to it (using asString printString).
And using comment of manifest class will avoid all this logic.

- it will avoid dummy comments of manifest classes.
Look at hierarchy of PackageManifest. All classes are commented with same string like

I store metadata for this package. These meta data are used by other tools such as the
SmalllintManifestChecker and the critics Browser

And in same time most of packages which they describe are not commented. It is weird.
With new approach we will have extra indication that package needs to be commented. Because uncommented manifest will be marked as other uncommented classes.

- Some manifests are already include package comment. So we will remove duplication

	Priority: 5 – Fix If Time		Status: Work Needed
	Assigned to: Everyone		Milestone: Pharo7.0

Go to Case

No longer need updates? Unsubscribe from this case.

Don't want Manuscript notifications anymore? Update your preferences.

_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
https://lists.gforge.inria.fr/mailman/listinfo/pharo-bugtracker