Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs - Gremlin customization #1367

Merged

Conversation

BlackDog86
Copy link
Contributor

Adds docs for Issue #380

@BlackDog86 BlackDog86 requested a review from Iridar August 3, 2024 15:53
@BlackDog86 BlackDog86 self-assigned this Aug 3, 2024
@BlackDog86 BlackDog86 added this to the 1.29.0 milestone Aug 3, 2024
@BlackDog86 BlackDog86 added the ready-to-review A pull request is ready to be reviewed label Aug 3, 2024
UseAppearance = OwningUnit.kAppearance;
UseAppearance.iArmorTint = UseAppearance.iWeaponTint;
UseAppearance.iArmorTintSecondary = UseAppearance.iArmorTintSecondary;
UseAppearance.nmPatterns = UseAppearance.nmWeaponPattern;
// End Issue #380
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see no reason to remove these two issue tags.

@Iridar Iridar added waiting-on-author A pull request is waiting on changes from the author docs and removed ready-to-review A pull request is ready to be reviewed labels Sep 5, 2024
@BlackDog86 BlackDog86 added ready-to-review A pull request is ready to be reviewed and removed waiting-on-author A pull request is waiting on changes from the author labels Sep 6, 2024
@BlackDog86 BlackDog86 force-pushed the 380-Gremlin-Customization-Docs branch 3 times, most recently from 271899c to f4dcb30 Compare October 29, 2024 00:28
@Iridar
Copy link
Contributor

Iridar commented Nov 2, 2024

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

@Iridar Iridar added waiting-on-author A pull request is waiting on changes from the author and removed ready-to-review A pull request is ready to be reviewed labels Nov 2, 2024
@BlackDog86
Copy link
Contributor Author

BlackDog86 commented Nov 2, 2024

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
Copy link
Contributor

Iridar commented Nov 2, 2024

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 BlackDog86 force-pushed the 380-Gremlin-Customization-Docs branch from 4b02ba5 to 289fd40 Compare November 2, 2024 09:54
@BlackDog86
Copy link
Contributor Author

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.

@BlackDog86 BlackDog86 added ready-to-review A pull request is ready to be reviewed and removed waiting-on-author A pull request is waiting on changes from the author labels Nov 2, 2024
@Iridar Iridar added ready-for-merge the pull request was reviewed and is ready to be merged. and removed ready-to-review A pull request is ready to be reviewed labels Nov 11, 2024
@Iridar Iridar merged commit 3f2f9b2 into X2CommunityCore:master Nov 11, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs ready-for-merge the pull request was reviewed and is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants