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

contrib: Fix check-doc script regexes #12820

Merged
merged 2 commits into from Mar 30, 2018

Conversation

maflcko
Copy link
Member

@maflcko maflcko commented Mar 28, 2018

Fixup the regexes to properly find all used args. The regex should now match all of the getter and setter methods of the ArgsManager. See https://dev.visucore.com/bitcoin/doxygen/class_args_manager.html#pub-methods

Before:

Args used        : 159
Args documented  : 188
Args undocumented: 0
Args unknown     : 29

After:

Args used        : 183
Args documented  : 188
Args undocumented: 0
Args unknown     : 5

@maflcko
Copy link
Member Author

maflcko commented Mar 28, 2018

You can disable the whitespace changes for review (e.g. on GitHub web view with 1360844?w=1)

@jnewbery
Copy link
Contributor

Tested ACK 1360844

Looks like it works. We can remove the help text for the non-existent -fuzzmessagestest (removed in ea33268)

@jnewbery
Copy link
Contributor

Oh, I wasn't suggesting we needed to do it here, but sure why not. Tested ACK 0c17e27

@meshcollider
Copy link
Contributor

Concept ACK, eventually this script will be unnecessary when the arguments are registered alongside their help text btw

@ajtowns
Copy link
Contributor

ajtowns commented Mar 29, 2018

Seems pretty reasonable. utACK 0c17e27

@maflcko maflcko merged commit 0c17e27 into bitcoin:master Mar 30, 2018
maflcko pushed a commit that referenced this pull request Mar 30, 2018
0c17e27 init: Remove help text for non-existent -fuzzmessagestest arg (MarcoFalke)
1360844 contrib: Fix check-doc script regexes (MarcoFalke)

Pull request description:

  Fixup the regexes to properly find all used args. The regex should now match all of the getter and setter methods of the `ArgsManager`. See https://dev.visucore.com/bitcoin/doxygen/class_args_manager.html#pub-methods

  Before:
  ```
  Args used        : 159
  Args documented  : 188
  Args undocumented: 0
  Args unknown     : 29
  ```

  After:
  ```
  Args used        : 183
  Args documented  : 188
  Args undocumented: 0
  Args unknown     : 5
  ```

Tree-SHA512: 1a7fb7ea55b2f6030358a1055d8f2c19b31f69d0603be0b009e6e603564014b4e2bb824357c9d43d0fba3ce7159b7c4e7eaa60b3f962053d94f73d0e626294fc
@maflcko maflcko deleted the Mf1803-qaCheckDocRegex branch March 30, 2018 15:59
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jul 17, 2020
0c17e27 init: Remove help text for non-existent -fuzzmessagestest arg (MarcoFalke)
1360844 contrib: Fix check-doc script regexes (MarcoFalke)

Pull request description:

  Fixup the regexes to properly find all used args. The regex should now match all of the getter and setter methods of the `ArgsManager`. See https://dev.visucore.com/bitcoin/doxygen/class_args_manager.html#pub-methods

  Before:
  ```
  Args used        : 159
  Args documented  : 188
  Args undocumented: 0
  Args unknown     : 29
  ```

  After:
  ```
  Args used        : 183
  Args documented  : 188
  Args undocumented: 0
  Args unknown     : 5
  ```

Tree-SHA512: 1a7fb7ea55b2f6030358a1055d8f2c19b31f69d0603be0b009e6e603564014b4e2bb824357c9d43d0fba3ce7159b7c4e7eaa60b3f962053d94f73d0e626294fc
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jul 17, 2020
0c17e27 init: Remove help text for non-existent -fuzzmessagestest arg (MarcoFalke)
1360844 contrib: Fix check-doc script regexes (MarcoFalke)

Pull request description:

  Fixup the regexes to properly find all used args. The regex should now match all of the getter and setter methods of the `ArgsManager`. See https://dev.visucore.com/bitcoin/doxygen/class_args_manager.html#pub-methods

  Before:
  ```
  Args used        : 159
  Args documented  : 188
  Args undocumented: 0
  Args unknown     : 29
  ```

  After:
  ```
  Args used        : 183
  Args documented  : 188
  Args undocumented: 0
  Args unknown     : 5
  ```

Tree-SHA512: 1a7fb7ea55b2f6030358a1055d8f2c19b31f69d0603be0b009e6e603564014b4e2bb824357c9d43d0fba3ce7159b7c4e7eaa60b3f962053d94f73d0e626294fc
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants