Mimic-Tools/name-generation

Allow comments in name files

Closed this issue · 1 comments

Sometimes we'd like to disable a 'bad' name or put in a contextual note.
for example, it might be nice to be able to have a note that says what type of name submissions are requested.

 # This file will be deprecated soon, so you may want to look at other-name.txt to make changes.
 John
 Mary
 Ali

The main thing stopping us having this is the generate.py script. It replaces the strings ["a-file"] with the contents of that file and seperates them with a | charcter.

e.g.
TAG = ["somefile"]
becomes
TAG = John | Mary | Ali
without comments, but if we added it in it would produce
TAG = #This file.... changes. | John | Mary | Ali
Allowing the comment to be selected as a name partial.

We should detect the comment and remove it before adding to the list of possible entries
https://github.com/Mimic-Tools/name-generation/blob/main/generate.py#L7

I think this is solved