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

fix(natives/rpc): Keep code fencing in doc summary #2570

Merged
merged 1 commit into from
Jul 23, 2024

Conversation

tens0rfl0w
Copy link
Contributor

Goal of this PR

Removing leading and trailing backticks from the native summary section breaks formatting if the summary only contains formatted code.

How is this PR achieving the goal

Removal of the regex pattern matching for leading and trailing backticks in the doc string parse function when native md is being generated.

See issue citizenfx/natives#1124 for a showcase of the mismatch between client and server native docs.

This PR applies to the following area(s)

Natives

Successfully tested on

Game builds: Not applicable

Platforms: Windows

Checklist

  • Code compiles and has been tested successfully.
  • Code explains itself well and/or is documented.
  • My commit message explains what the changes do and what they are for.
  • No extra compilation warnings are added by these changes.

Fixes issues

fixes citizenfx/natives#1124

* Removing leading and trailing backticks from the native summary section breaks formatting if the summary only contains formatted code.
* Keep RPC native summary in sync with client native summary.
@github-actions github-actions bot added the triage Needs a preliminary assessment to determine the urgency and required action label Jun 1, 2024
@prikolium-cfx prikolium-cfx added ready-to-merge This PR is enqueued for merging and removed triage Needs a preliminary assessment to determine the urgency and required action labels Jul 23, 2024
@prikolium-cfx prikolium-cfx merged commit 9922dc9 into citizenfx:master Jul 23, 2024
3 checks passed
@tens0rfl0w tens0rfl0w deleted the fix/codegen-rpc-summary branch July 23, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge This PR is enqueued for merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SET_PED_CONFIG_FLAG RPC native takes a long time to load
2 participants