The term TODO in upgrade.md is misleading

[sjabbott78]

I was wondering why you are using the term "TODO" in your upgrade.md doc. To me that term means it has not been done yet and is being planned or in the process of being done. But when I dig deeper I see that you have actually done those items. Maybe the term "DONE" or "COMPLETED" would better reflect that these items have been completed.

[adrianbj]

This confused me also - I think it's supposed to mean that those using the new version need "to do" those changes, but I think each bullet point should be reworded to explain what the end user needs to do or know, for example:

• add Adminer namespace
• change adminer_object() to create_adminer()
• plugins are no longer autoloaded based on class name
• use config option visibleCollations as a replacement for the plugin AdminerCollations

[sjabbott78]

That is what I mean by saying the term is misleading. Looking at the code the user who compiles this branch does not need to do those items such as adding Adminer namespace because @peterpp has already done that. And that seems to be the case with all of those TODO's.

[adrianbj]

I don't think it's quite that simple (it least how I am reading it).

For example, if you're including a plugin you either need to namespace your index.php file with Adminer, or add Adminer to the the new, eg: new \Adminer\AdminerDumpZip or add a use for that plugin before instantiating it.

When setting up Adminer, you now need to use adminer_object() to createAdminer().

You now need to use the config option visibleCollations because AdminerCollations no longer works or isn't necessary.

So I think this is a list of things the user needs to do, rather than a list of things that @peterpp has done, but who knows, maybe I am interpreting incorrectly 😁

[sjabbott78]

That is the whole point, I do not know which way to interpret it either 😁

[wintstar]

I think there will be a plausible explanation. I can imagine that the file todo.txt is still included in the package by mistake. Maybe you forgot to update or remove them.

[peterpp]

It's simple. Document upgrade.md is not finished yet. All those TODOs mean that I want/need to explain each point in more detail, with examples, etc. These are notes for me not to forget anything. All of these features are already implemented.

[peterpp]

I've just updated upgrade.md file with proper instructions and will keep it up to date.