Skip to content

document vb shoulds#5004

Merged
aMannus merged 1 commit intoHarbourMasters:developfrom
briaguya0:document-vb-shoulds
Feb 8, 2025
Merged

document vb shoulds#5004
aMannus merged 1 commit intoHarbourMasters:developfrom
briaguya0:document-vb-shoulds

Conversation

@briaguya0
Copy link
Contributor

@briaguya0 briaguya0 commented Feb 5, 2025

what this PR does

  • moves the GIVanillaBehavior enum out of GameInteractor.h into a new file
  • sorts the enum alphabetically
  • adds consistently styled documentation to every entry
  • ensures that documentation matches reality

what this PR doesn't do

  • clean up any actual usage of VB_SHOULDs in code
  • remove any unused VB_SHOULDs
  • anything beyond documentation
    • my goal is to land this PR and have consistent documentation in the enum to work from as we figure out how we'd like to address findings in clean up GIVanillaBehavior #4997

Build Artifacts

Copy link
Contributor

@aMannus aMannus left a comment

Choose a reason for hiding this comment

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

Absolutely massive. I'm going to try my best to let future VB's follow the same documentation, which should be a lot easier with this pattern being much clearer.

@aMannus aMannus merged commit 6abf30a into HarbourMasters:develop Feb 8, 2025
5 checks passed
@briaguya0 briaguya0 deleted the document-vb-shoulds branch February 9, 2025 05:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants