Skip to content

Consider validating inline references to symbols #295

@Earthcomputer

Description

@Earthcomputer

That is, for example, stuff like `Item.Settings`, which in a recent PR I had to correct from `Items.Settings`. Classes, methods and fields would need to be validated, with different formatting options to show them with or without their owning class and method parameters. You would need a way of marking which formatting style you want, and a way of differentiating them inline code blocks which should not be validated.

Doing this validation would have the following advantages:

  • Being able to catch typos and incorrect references.
  • Making the tutorials easier to maintain when the game or mappings update.
  • Making auto-remapping of tutorials (e.g. to Mojmap) more possible in the future.

Metadata

Metadata

Assignees

No one assigned

    Labels

    help-wantedAnyone is welcome to work on thisimprovementA new addition to an already existing pagepriority:mediumThis is medium priority - it should be addressed relatively quickly.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions