interTwin-eu / interlink-slurm-plugin

MIT License
1 stars 3 forks source link

rename aux.go #16

Closed antoinetran closed 4 months ago

antoinetran commented 4 months ago

Short Description of the issue

In Windows, aux is a reserved name. It is not possible to name a file like this, or else an invalid name error appears. Even for aux.go. Thus it is not possible to clone in Windows this repository.

Environment

Steps to reproduce

Logs, stacktrace, or other symptoms

output

Summary of proposed changes

If it is not too much of a hassle, can someone rename the file? I can see similar error like https://github.com/mhausenblas/burry.sh/issues/13

dciangot commented 4 months ago

+1 I didn't find it to be a good name anyway. @antoinetran if you have any good name in mind please go ahead and feel free to propose a PR. Otherwise I'll let @Surax98 come up with one.

The change should have 0 impact everywhere else.

Surax98 commented 4 months ago

Yeah, literally 0 impact. Just let me know if I have to think about anything or not

dciangot commented 4 months ago

looking at the content, to me either prepare.go or preparation.go is kind of fine. They are all functions meant to prepare the slurm submission. Maybe prepare is slightly better. I no one object, I'd go with prepare.go

Surax98 commented 4 months ago

Or just... func.go? I mean, the majority are to prepare for the slurm submission, but some are just wrappers or to check if a value is stored in memory.

dciangot commented 4 months ago

in general is useful to avoid generic name where to put "everything else".

so, if there is something other then preparation, we might think of moving that function somewhere else. Also, checking if a value is in memory can be considered as a preparatory step.

so I still suggest prepare.go

antoinetran commented 4 months ago

+1 I didn't find it to be a good name anyway. @antoinetran if you have any good name in mind please go ahead and feel free to propose a PR. Otherwise I'll let @Surax98 come up with one.

I am not familiar with the code, but looking into it, it looks like related to the singularity containers. So I don't know, what about container_func.go? Or prepare.go or whatever you find it relevant :)

Surax98 commented 4 months ago

Addressed in bbf43b3