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 info regarding opt-in attributes #20

Open
Luc1412 opened this issue Sep 3, 2024 · 1 comment · May be fixed by #28
Open

Add info regarding opt-in attributes #20

Luc1412 opened this issue Sep 3, 2024 · 1 comment · May be fixed by #28
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Luc1412
Copy link
Member

Luc1412 commented Sep 3, 2024

The docs should include a warning/info for attributes that require opt in. The user should be also educated on how to opt-in.

This includes:

  • item_preview_hero_path
  • display_asset_path
  • definition_path
  • path
  • gameplay_tags
  • shop_history
@Luc1412 Luc1412 added the documentation Improvements or additions to documentation label Sep 3, 2024
@trevorflahardy
Copy link
Collaborator

As a side note, this would best be served as a custom sphinx directive for the sake of removing repetition.

@trevorflahardy trevorflahardy linked a pull request Oct 12, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants