Ticket #0001807

Type	Wish	Status	reviewed	Date	23-Dec-2010 22:30
Version	alpha 110	Category	Unspecified	Submitted by	abolka
Platform	All	Severity	minor	Priority	normal

Summary	Unify naming between the "isolate" module header option and the "no-share" IMPORT refinement
Description	Brian Hawley mentioned on AltME that "/no-share sets options: [isolate]". If those two options really have basically the same effect (except for module users and one for module authors), using the same name for them seems appropriate. Brian also hinted at the "exceptional case" these flags implement. Based on that, I would suggest sticking to the "no-share" name and renaming the "isolate" module header option to "no-share".
Example code

Assigned to	n/a	Fixed in	-	Last Update	3-Mar-2015 10:54

Comments
(0002993) BrianH 27-Dec-2010 05:37	These are exceptional cases when specified on import, but they are normal cases when specified in the module header. The reason for this is that these options can affect the semantics of the module in certain cases, so they would preferably be specified by its author in the header, and sometimes require that the module source be modified accordingly. There is a similar situation with the [private] header option, which is sort of related to both the /no-lib and /no-user IMPORT options, but not completely. The /no-share option is also named for consistency with /no-lib and /no-user, even though the old name /isolate might be better suited to describe its behavior. Given that the IMPORT options and header options don't completely or necessarily correspond to each other, it may not be bad if the names don't match either. When it comes down to it, none of these names are expected to completely describe their behavior - that is why they're called names, not descriptions.
(0004586) BrianH 3-Mar-2015 10:54	OK, given #2115 and #2116, it looks like a terminology change would make sense for some options. /no-user and /no-lib should stay the same. Instead, per #2115, we're replacing the private option with the opposite lib option. /no-share should be changed to /isolate in import, sys/do-needs and sys/load-module. We should consider whether to rename the module function's /mixin option and the mixin? function, since we're not really using the term "mixin" anymore. Or are we? That means we're going to need a PR for this. It will probably have #2114, #2115, #2116, #1877 and #1941 as prerequisites.

Comments

(0002993)
BrianH
27-Dec-2010 05:37

These are exceptional cases when specified on import, but they are normal cases when specified in the module header. The reason for this is that these options can affect the semantics of the module in certain cases, so they would preferably be specified by its author in the header, and sometimes require that the module source be modified accordingly.

There is a similar situation with the [private] header option, which is sort of related to both the /no-lib and /no-user IMPORT options, but not completely. The /no-share option is also named for consistency with /no-lib and /no-user, even though the old name /isolate might be better suited to describe its behavior.

Given that the IMPORT options and header options don't completely or necessarily correspond to each other, it may not be bad if the names don't match either. When it comes down to it, none of these names are expected to completely describe their behavior - that is why they're called names, not descriptions.

(0004586)
BrianH
3-Mar-2015 10:54

OK, given #2115 and #2116, it looks like a terminology change would make sense for some options.

/no-user and /no-lib should stay the same. Instead, per #2115, we're replacing the private option with the opposite lib option.

/no-share should be changed to /isolate in import, sys/do-needs and sys/load-module.

We should consider whether to rename the module function's /mixin option and the mixin? function, since we're not really using the term "mixin" anymore. Or are we?

That means we're going to need a PR for this. It will probably have #2114, #2115, #2116, #1877 and #1941 as prerequisites.

Date	User	Field	Action	Change
3-Mar-2015 10:54	BrianH	Comment : 0004586	Added	-
17-Jan-2011 04:28	carl	Status	Modified	submitted => reviewed
27-Dec-2010 05:37	BrianH	Comment : 0002993	Added	-
23-Dec-2010 22:30	abolka	Summary	Modified	Unify naming between the "isolate" module header option and the /no-share IMPORT refinement => Unify naming between the "isolate" module header option and the "no-share" IMPORT refinement
23-Dec-2010 22:30	abolka	Description	Modified	-
23-Dec-2010 22:30	abolka	Ticket	Added	-