Ruby documentation step 1: placeholders and checks #1683
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shorowit
reviewed
Apr 12, 2024
…tinue to add docs.
|
Let's script (or otherwise pre-populate) each of the method's tags/docstrings and get that merged up front. This would:
|
shorowit
reviewed
May 15, 2024
stub-docs.rb
Outdated
|
|
||
| require_relative file | ||
|
|
||
| new_classes = ObjectSpace.each_object(Class).to_a - previous_classes |
There was a problem hiding this comment.
Admittedly, running into trouble using this approach of trying to require the file and then get classes/methods out of it. Repeated/nested class/method names cause issues. Instead of getting the script to operate perfectly, it may be a more effective use of time to take over with manual edits.
There was a problem hiding this comment.
Go with whatever it easiest. I assume the script is temporary and will be deleted before merging.
There was a problem hiding this comment.
Yes, I was only planning to use it as a temporary helper script.
joseph-robertson
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Addresses #1682.
Adds cops:
Exclude non "resource" files (and hpxml.rb) from these cops. Stub documentation for all included classes/methods.
Adds a new "Check measures" step to the run-unit-tests GHA job. The step runs
update_measuresand exits if:Add a new test for reporting documentation coverages.
Checklist
PR Author: Check these when they're done. Not all may apply.
strikethroughand check any that do not apply.PR Reviewer: Verify each has been completed.
EPvalidator.xml) has been updatedopenstudio tasks.rb update_hpxmls)HPXMLtoOpenStudio/tests/test*.rband/orworkflow/tests/test*.rb)openstudio tasks.rb update_measureshas been run