search

WildcardSearch / Advanced-Sidebox

A plugin for MyBB forums that displays custom boxes on various forum pages.
GNU General Public License v3.0
20 stars 10 forks source link

Removing Example Modules #175

Closed WildcardSearch closed 10 years ago

WildcardSearch commented 10 years ago

It has been in my mind for some time to stop serving the example modules with the installation package. The main reason is that (probably) no one is using them and they are just clutter.

Since this version is updating module extensibility requirements and at least one of the modules would require changes, it seems best to me that if modules are removed from the package, they should also be removed from the plugin. I would of course check to ensure that the module is not being used before uninstalling it. I would also start a repo for example modules and since it would then not have an impact on the clutter of the plugin on default install, I could create more examples for the newer functionality without concern.

Any thoughts on this before I make a decision?

EDIT: It literally just occurred to me that example modules are removed, the language would also need to be removed-- although this might cause the modules to malfunction if somehow left behind.

Tanweth commented 10 years ago

Go for it. They're there as a developer's resource, so I'd be surprised if anyone was actively using them, and it does add confusion and clutter to have them in the modules list with the other modules. And since for 99% of users they aren't going to be useful, it makes sense to store them separately for developers to refer to if they decide to develop for ASB.

If it were me, I'd probably just remove the language entries and have the upgrade script remove the files from the ASB modules directory if they exist. I can't imagine anyone is using them as modules, unless a developer decided to customize an existing example module with the same filename and language entries rather than making a new one (which is bad practice anyway :tongue: ), so I don't think it's worth losing sleep over.

WildcardSearch commented 10 years ago

I'm going to commit to this for 2.1-- I think it is for the best.

WildcardSearch commented 10 years ago

EDIT: It literally just occurred to me that example modules are removed, the language would also need to be removed-- although this might cause the modules to malfunction if somehow left behind.

Well it literally didn't occur to me while coding . . . still need to remove the example module language.