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

Ensure that we have covered with tests some constants phpdoc checks #110

Merged
merged 1 commit into from
Jul 5, 2023

Conversation

stronk7
Copy link
Member

@stronk7 stronk7 commented Jul 2, 2023

  1. Constants have to be documented.
  2. The @const tag is forbidden. Constants are documented with @var, if anything.

Note that this does not change anything in moodlecheck, but just covers with tests the detection of undocumented constants and the (incorrect) use of the @const tag.

Note that this is part of https://tracker.moodle.org/browse/MDL-77599

1. Constants have to be documented.
2. The @const tag is forbidden. Constants are documented with @var, if
   anything.

Note that this does not change anything in moodlecheck, but just covers
with tests the detection of undocumented constants and the (incorrect)
use of the @const tag.

Note that this is part of https://tracker.moodle.org/browse/MDL-77599
@HuongNV13 HuongNV13 assigned HuongNV13 and unassigned HuongNV13 Jul 3, 2023
@HuongNV13 HuongNV13 self-requested a review July 3, 2023 09:02
@HuongNV13
Copy link
Contributor

Thanks, Eloy,
The changes look good to me.

@HuongNV13 HuongNV13 merged commit 6110774 into moodlehq:master Jul 5, 2023
18 checks passed
@stronk7
Copy link
Member Author

stronk7 commented Jul 6, 2023

Thanks @HuongNV13 !

@stronk7 stronk7 deleted the const_tests branch July 6, 2023 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants