Microdown icon indicating copy to clipboard operation
Microdown copied to clipboard

Dumpers, Writers, Composers and Exporters

Open hernanmd opened this issue 3 years ago • 1 comments

Multiple visitor classes have different naming conventions. For example inspecting:

#visitBold: implementors

It would be nice to avoid confusion to have a single naming conventions for Visitors. Something like:

MicHTMLWriter -> MicHTMLVisitor MicLaTeXWriter -> MicLaTeXVisitor MicRealDumper ?? (this seems to be a code generator used for tests?) MicRichTextComposer -> MicRichTextVisitor MicTextualMicrodownExporter -> MicTextualVisitor

What do you think?

hernanmd avatar Feb 12 '22 19:02 hernanmd

I prefer names which indicate what things do rather than what they do (visit). As I have seen composers, writers and a few others I am not sure there is an issue. But as I am daily struggling with trying to understand the code of others I appreciate any kind of naming scheme which is consistent, and visitor is a consistent scheme. However, I also believe any class that implement a visitX: method is most likely a visitor, and I will look at its superclass to see which kind.

In summary - I can see the issue, but is not quite convinced it is a problem.

kasperosterbye avatar Feb 13 '22 14:02 kasperosterbye