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

Potential error inside of a code tag, found a string that looks like a closing tag #65780

Open
madmiraal opened this issue Sep 14, 2022 · 0 comments

Comments

@madmiraal
Copy link
Contributor

Godot version

master (d9e974c)

System information

N/A

Issue description

Static checks, includes documentation checks, which runs doc/tools/make_rst.py:

- name: Documentation checks
run: |
doc/tools/make_rst.py --dry-run --color doc/classes modules

Currently this is generating multiple "Potential error inside of a code tag, found a string that looks like a closing tag" warnings:
WARNING: @GlobalScope.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/b]" in method "print_rich" description.
WARNING: @GlobalScope.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/code]" in method "print_rich" description.
WARNING: @GlobalScope.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/b]" in method "print_rich" description.
WARNING: RichTextEffect.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/example]" in class "RichTextEffect" description.
WARNING: RichTextEffect.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/example]" in class "RichTextEffect" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/b]" in class "RichTextLabel" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/i]" in class "RichTextLabel" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/i]" in class "RichTextLabel" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/b]" in class "RichTextLabel" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/i]" in class "RichTextLabel" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/center]" in class "RichTextLabel" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/url]" in signal "meta_clicked" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/hint]" in property "hint_underlined" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/url]" in property "meta_underlined" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/hint]" in method "push_hint" description.
WARNING: RichTextLabel.xml: Potential error inside of a code tag, found a string that looks like a closing tag "[/url]" in method "push_meta" description.

16 warnings were found in the class reference XML. Please check the messages above.

These warnings were introduced with #64230, which identifies that it generates these false positives. However, no issue was created; so it takes some digging to realise that this is a known issue.

Note: These warnings become visible when creating a PR and the "Documentation Checks" generate an error, which is confusing, because the warnings have nothing to do with the PR and we're used to all warnings being treated as errors.

Steps to reproduce

Look at the static checks log https://github.com/godotengine/godot/actions/runs/3051084618/jobs/4918897916 under "Documentation Checks"

Minimal reproduction project

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants