Skip to content

Conversation

@imvanni
Copy link

@imvanni imvanni commented Oct 18, 2024

Changes

Adds the previously missing documentation for ResetPropertyToDefault.

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@imvanni imvanni requested a review from a team as a code owner October 18, 2024 22:37
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Oct 18, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hi @imvanni, thanks so much for helping improve the Roblox creator documentation! Our technical writing team will review your pull request soon. In the meantime, please ensure you've read through the README.md, contribution guidelines, and style recommendations.

Choose a reason for hiding this comment

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

Error validating YAML against schema tools/schemas/engine/classes.json:

[
  {
    "instancePath": "/methods/26",
    "schemaPath": "#/properties/methods/items/required",
    "keyword": "required",
    "params": {
      "missingProperty": "code_samples"
    },
    "message": "must have required property 'code_samples'"
  }
]

⛔️ This change is a requirement. Please fix it before merging.

Choose a reason for hiding this comment

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

Only the following fields are editable: summary, description, deprecation_message. Other fields are automatically overwritten if edited. Please undo changes to the following fields:

  • methods.26.name
  • methods.26.code_samples
  • methods.26.code_samples
  • methods.26.parameters.0.name
  • methods.26.parameters.1
  • methods.26.parameters.1
  • methods.26.deprecation_message
  • methods.26.code-samples
  • methods.26.code-samples
  • methods.26.deprecation-message
  • methods.26.deprecation-message
  • methods.27.name
  • methods.27.code_samples
  • methods.27.parameters.0.name
  • methods.27.parameters.1.name
  • methods.27.parameters.1.type
  • methods.27.returns.0.type
  • methods.27.tags.0
  • methods.27.tags.0
  • methods.27.tags.1
  • methods.27.tags.1
  • methods.28.name
  • methods.28.code_samples
  • methods.28.parameters.0
  • methods.28.parameters.0
  • methods.28.parameters.1
  • methods.28.parameters.1
  • methods.28.returns.0.type
  • methods.28.tags.0
  • methods.28.tags.1
  • methods.28.tags.1
  • methods.29.name
  • methods.29.returns.0.type
  • methods.30.name
  • methods.30.returns.0.type
  • methods.31.name
  • methods.31.parameters.0
  • methods.31.parameters.0
  • methods.31.parameters.1
  • methods.31.parameters.1
  • methods.31.returns.0.type
  • methods.32.name
  • methods.32.parameters.0
  • methods.32.parameters.0
  • methods.32.parameters.1
  • methods.32.parameters.1
  • methods.32.returns.0.type
  • methods.33.name
  • methods.33.parameters.0
  • methods.33.parameters.0
  • methods.33.returns.0.type
  • methods.34.name
  • methods.34.parameters.0
  • methods.34.parameters.0
  • methods.34.returns.0.type
  • methods.35
  • methods.35

⛔️ This change is a requirement. Please fix it before merging.

@github-actions github-actions bot added the changes requested This pull request has changes requested prior to merging label Oct 18, 2024
@imvanni
Copy link
Author

imvanni commented Oct 18, 2024

Ah, are we not allowed to add new elements? Welp.

This method is currently working in the Engine. Minimal documentation is expected, thank you.

@imvanni imvanni closed this Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changes requested This pull request has changes requested prior to merging engine reference Changes the Engine API Reference documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant