New unique names requirement for File Exchange addons
I got an email message that says all the files I've uploaded to the File Exchange will be given unique names. Are these new names being applied to my files automatically? If so, do I need to download them to get versions with the new name so that if I update them they'll have the new name instead of the name I'm using now?
9 Comments
Time Descending
This clarification really helps
From what I understand now, the unique name is basically a backend identifier for the upcoming MATLAB Package Manager support, not something that changes our actual file names, titles, or URLs on File Exchange. That makes sense from a dependency and installation perspective.
I think the email wording caused confusion because it sounded like files themselves might be renamed, which would have big implications for updates and version control. It’s reassuring to know everything will be applied automatically and that no re-upload or manual rename is required.
It would be great if there were also a public way to check which unique names are already claimed before choosing one — especially for common names.
Thanks for the clarification!
Should we understand this as "half namespace"? As in "half-way" to python's "include numpy as n"?
"Are these new names being applied to my files automatically?"
The name is for the whole add-on (which in future will all be packages), not for the individual files.
Presumably unique add-on names will allow unambiguous integration with the IDE.
If I recall correctly, this is to make sure that there is a unique name for the package manager to work. The function name itself shouldn't change (as far as I'm aware).
It is just a bit sad for me that the name readfile was already claimed, even if I can't find which package that would be. Luckily most of my submissions do something no other submission is doing (hence me having had to make them), so the renames are very limited for me.
I'm curious, how is that for you?
"It is just a bit sad for me that the name readfile was already claimed, even if I can't find which package that would be"
Searching for READFILE on FEX brings up quite a number of files which use that name, presumably one of their authors already grabbed the add-in name READFILE. But currently we have no way to know.
I cannot decide if the add-on names should be as short as possible (e.g. match the (main) filename) or longer and slightly descriptive. Knowing the context of how it will be displayed would help clear this up.
Hi Stephen,
These new names will come into effect when File Exchange is supported by the MATLAB Package Manager. They will be used to install a submission via the mpminstall command. They will also be used when declaring dependencies on submissions in File Exchange. We created a naming standard to prioritize names that are short and readable:
- Use all lowercase letters, e.g., myname
- Use _ for longer names, e.g., my_extraordinarily_long_name
I hope this gives some better context for how the names will be used!
@Chandler Crane, not sure I understand. Can you answer my original question more directly? "Do I need to download them to get versions with the new name so that if I update them they'll have the new name instead of the name I'm using now?"
No additoinal action is required on your end. This unique name is a new attribute for your submission that does not affect the title, file names, or URL of your submission.
When File Exchange is supported by the MATLAB Package Manager, these new names will go into effect. All versions of your submissions will "automatically" get the names you chose, i.e. they will be installable using the unique name with the mpminstall command.
This may not be completely technically correct and reflect how MATLAB Package Manager will actually work "When File Exchange is supported by the MATLAB Package Manager", but I think it's close. Chandler, feel free to correct me if I'm incorrect.
These names that you're choosing for your submissions will be the names that users of mpminstall will use as (all or part of) the packageSpecifier input to choose to install your submission. If you look at the description of packageSpecifier on that doc page, you can specify just the ID of the package (which should get the latest version) or an ID and version (which should get that specific version.)
These packageSpecifiers/IDs are different from the name of the submission that appears at the top of the File Exchange page. Think of it like your name and email address. My "packageSpecifier" for the mathworks.com "repository" would be the first part of my email address (and I have different "packageSpecifiers" for other "repositories" like gmail), while my name remains Steve Lord.
Sign in to participate
