search

wiremod / wire

Garry's Mod add-on that allows users to wire up components in order to make more elaborate automatic and user-controlled contraptions.
http://www.wiremod.com
Apache License 2.0
547 stars 332 forks source link

Update new expression2 file comment #3083

Closed deltamolfar closed 1 month ago

deltamolfar commented 1 month ago

Makes it a little more modern. Can be used to tell players that don't sit on Discord/don't follow GitHub updates what's new. Informs regulars players about events/lambdas.

wrefgtzweve commented 1 month ago

I feel like updates shouldn't be in there as it'll likely rarely be updated.

deltamolfar commented 1 month ago

If so, it can be renamed to latest features, to inform about latest big stuff

wrefgtzweve commented 1 month ago

My point still stands then, a string in a file somewhere isn't a good way to display new features and will simply age poorly.

deltamolfar commented 1 month ago

Well, it also can be done by either placing a global var somewhere, but the problem would be the same, or by making new GitHub action to append the PR name, but that would make also show unrelated to E2 updates. I'm open to removing it, but I would say that it would be better to leave it to inform about big things that wouldn't be discovered in other way then from Discord/GitHub.

Periapsises commented 1 month ago

My point still stands then, a string in a file somewhere isn't a good way to display new features and will simply age poorly.

I don't think a lot of people will remember to include their changes in there. If there was a way to automate it, that would be great.

deltamolfar commented 1 month ago

Thanks @Periapsises, I commited them

Denneisk commented 1 month ago

I think the changelog is going to be more trouble than it's worth. I'd like an in-editor changelog feature as well but I haven't thought on how to best approach such a thing.

The phrase "and their benefits" seems a little tacky in my opinion. :P

deltamolfar commented 1 month ago

Changelog - well tbh no idea, you lads can keep it or remove it, I don't really mind.

But "And their benefits" is for those that doesn't want to learn new things, and switch to better ways of doing things.

deltamolfar commented 1 month ago

Regarding news, I think separate file with new and old news can easily be added, which later on could be used to show news, with an inbox icon (similar to credits icon) with a read/not read support. Code wise it would just be a panel with static text from the said file

deltamolfar commented 1 month ago

Well, it can be done like that. To be honest I don't particulary care about the description format as much, as about it being informative about concepts that aren't easily discoverable by E2Helper (lambdas, events, and why @strict) mainly