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

docs: add info for mutation enchantments #4118

Merged

Conversation

RoyalFox2140
Copy link
Collaborator

Purpose of change

There was poor documentation for adding effects via mutation, I added documentation for doing this with mutation enchantments.

Describe the solution

In json_info.md The field for enchantments is added.

in effects_json.md I gave an in-repo example of a mutation that grants an enchantment, and an example of an enchantment that grants a permanent effect.

Describe alternatives you've considered

Keeping it a mystery because that's funnier. Bugging others.

Testing

It's docs.

Additional context

Pain

@github-actions github-actions bot added the docs PRs releated to docs page label Jan 17, 2024
Copy link
Contributor

autofix-ci bot commented Jan 17, 2024

The Autofix app has found code style violation and automatically formatted this Pull Request.

I locally edit my commits (e.g: git, github desktop)

Please choose following options:

I'd like to accept the automated commit
  1. Run git pull. this will merge the automated commit into your local copy of the PR branch.
  2. Continue working.
I do not want the automated commit
  1. Format your code locally, then commit it.
  2. Run git push --force to force push your branch. This will overwrite the automated commit on remote with your local one.
  3. Continue working.

If you don't do this, your following commits will be based on the old commit, and cause MERGE CONFLICT.

This PR is complete and I don't want to edit it anymore

It's safe to ignore this message.

I edit this PR through web UI

You can ignore this message and continue working.

I have no idea what this message is talking about

You can ignore this message and continue working. If you find any problem, please ask for help and ping @scarf005.

@RoyalFox2140
Copy link
Collaborator Author

A note to onlookers that want to change the docs, don't assume because you're in an IME that it will be formatted on the web page. Use json

@chaosvolt chaosvolt dismissed scarf005’s stale review January 18, 2024 00:28

I hate that tackling a change request comment will correctly reseolve the associated conversation but doesn't dismiss the linked review weh >:C

Copy link
Member

@chaosvolt chaosvolt left a comment

Choose a reason for hiding this comment

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

Seems to be gud :>

@scarf005
Copy link
Member

dismissing existing reviews doesn't do anything, approving does.

@scarf005 scarf005 merged commit 8aad02c into cataclysmbnteam:main Jan 18, 2024
3 checks passed
@RoyalFox2140 RoyalFox2140 deleted the docs-for-mutation-enchantments branch July 14, 2024 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PRs releated to docs page
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants