search

X2CommunityCore / X2WOTCCommunityHighlander

https://steamcommunity.com/workshop/filedetails/?id=1134256495
MIT License
60 stars 69 forks source link

Add docs - Gremlin customization #1367

Closed BlackDog86 closed 2 weeks ago

BlackDog86 commented 4 months ago

Adds docs for Issue #380

Iridar commented 3 weeks ago

I'm sorry, but this still seems to remove Start Issue / End Issue tags in XComUnitPawn, what's up with that?

BlackDog86 commented 3 weeks ago

I'm sorry, but this still seems to remove Start Issue / End Issue tags in XComUnitPawn, what's up with that?

I explained this in the comment above -

The original file had this:

issue # X
<some code>
end issue # X    <---- remove this 
issue # X again <----- remove this 
<some code>
end issue # X

I simply changed to 

issue #x
<some code>
end issue #x
Iridar commented 3 weeks ago

I see.

The purpose of ref:Bugfixes docs is to be user-facing. As in, it should be treated as an entry in a changelog that explains the bug that is being fixed to Highlander users. If it's just a comment that explains to Highlander maintainers and Highlander-using mod authors, it doesn't need a docs entry.

Something like "Moved earlier so we can call SetAppearance() whether a new pawn is created or not" doesn't really explain what is being fixed here, so if you could reword it a bit, it would be appreciated.

BlackDog86 commented 3 weeks ago

I see.

The purpose of ref:Bugfixes docs is to be user-facing. As in, it should be treated as an entry in a changelog that explains the bug that is being fixed to Highlander users. If it's just a comment that explains to Highlander maintainers and Highlander-using mod authors, it doesn't need a docs entry.

Something like "Moved earlier so we can call SetAppearance() whether a new pawn is created or not" doesn't really explain what is being fixed here, so if you could reword it a bit, it would be appreciated.

Yep, I see what you mean. That should be done now.