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

Ruby documentation step 1: placeholders and checks #1683

Merged
merged 67 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
bd3a56c
Add workflow test file for checking doc percent.
joseph-robertson Apr 10, 2024
cd55832
Add rake task and update config.
joseph-robertson Apr 10, 2024
c30615d
Merge branch 'master' into ruby-docs
joseph-robertson Apr 11, 2024
057691a
Merge branch 'master' into ruby-docs
joseph-robertson Apr 12, 2024
f201a74
Report more coverage information.
joseph-robertson Apr 12, 2024
77f234f
Merge branch 'master' into ruby-docs
joseph-robertson Apr 12, 2024
57fbac4
Try yard rake task and cli.
joseph-robertson Apr 22, 2024
bdb19a3
Merge branch 'master' into ruby-docs
joseph-robertson Apr 22, 2024
cb4baf4
Add documentation cops and try update_measures on gha.
joseph-robertson Apr 22, 2024
ae0726c
Try exit code when update_measures contains string.
joseph-robertson Apr 23, 2024
4479bc6
Check if block.
joseph-robertson Apr 23, 2024
f62b2ba
Another try capturing stderr.
joseph-robertson Apr 23, 2024
2b1dde1
Exclude test files from documentation requirement using rubocop yml f…
joseph-robertson Apr 23, 2024
221bd01
Stub documentation comments for all build measure methods.
joseph-robertson Apr 23, 2024
b61a3ea
Revert changes to config, gemfile, rakefile.
joseph-robertson Apr 23, 2024
a604e2f
Merge branch 'master' into ruby-docs
joseph-robertson Apr 23, 2024
95cb226
Revert a bunch of unintended formatting.
joseph-robertson Apr 23, 2024
53f13d5
Fix more bad formatting.
joseph-robertson Apr 23, 2024
7230e72
Update build measure resources with kw args.
joseph-robertson Apr 24, 2024
464e8df
Start adding docs to geometry resources.
joseph-robertson Apr 24, 2024
59a16c2
Merge branch 'master' into ruby-docs
joseph-robertson Apr 24, 2024
409f378
Fix some confusion and inconsistencies around private statements, con…
joseph-robertson Apr 24, 2024
428c364
Update to kw args in translator geometry resource.
joseph-robertson Apr 25, 2024
7082e3d
Forgot to put the class method selfs back in.
joseph-robertson Apr 25, 2024
d2746ba
Geometry kw arg updates.
joseph-robertson Apr 29, 2024
ca5fc2e
Another kw arg update.
joseph-robertson Apr 29, 2024
ffa345e
Progress.
joseph-robertson Apr 29, 2024
54bcd49
Merge branch 'master' into ruby-docs
joseph-robertson May 8, 2024
5b618f0
First cut at a script for stubbing resource docs.
joseph-robertson May 15, 2024
47a2732
Add resources with first cut docs placeholders.
joseph-robertson May 15, 2024
1f866c5
Merge branch 'master' into ruby-docs
joseph-robertson May 15, 2024
30ebb11
Fix docs with multiple description lines.
joseph-robertson May 15, 2024
4e9a8c3
Actually copy the files in.
joseph-robertson May 15, 2024
6c4fc63
Add description placeholder above class.
joseph-robertson May 15, 2024
cfc27f2
Remove whitespace.
joseph-robertson May 15, 2024
01beeba
Fix return stub.
joseph-robertson May 15, 2024
23a4c27
Updates for common arguments.
joseph-robertson May 15, 2024
ea1b960
More progress.
joseph-robertson May 15, 2024
57ea82e
More refactoring.
joseph-robertson May 15, 2024
ee67cc3
Progress.
joseph-robertson May 15, 2024
01af03b
Update gitignore, rubocop yml, remove script.
joseph-robertson May 15, 2024
36fb66d
Few more excludes, and some cleanup.
joseph-robertson May 15, 2024
da7070e
More cleanup.
joseph-robertson May 15, 2024
af359d6
Fix some required args.
joseph-robertson May 16, 2024
2a5a6db
Remove remaining todo in hpxml.rb.
joseph-robertson May 16, 2024
8336761
Merge branch 'master' into ruby-docs
joseph-robertson May 16, 2024
c821a7d
Merge branch 'master' into ruby-docs
joseph-robertson May 16, 2024
0d6aa1a
More cleanup.
joseph-robertson May 16, 2024
e7f7c13
Merge branch 'master' into ruby-docs
joseph-robertson May 16, 2024
167e5ec
Measure xml update.
joseph-robertson May 16, 2024
3588fe3
Merge branch 'master' into ruby-docs
joseph-robertson May 19, 2024
517b644
Merge branch 'master' into ruby-docs
joseph-robertson May 20, 2024
22ce54c
Update measure xml.
joseph-robertson May 20, 2024
e0d47de
Merge branch 'master' into ruby-docs
joseph-robertson May 23, 2024
5beb1b9
Update measure xml.
joseph-robertson May 23, 2024
33051b2
Merge branch 'master' into ruby-docs
joseph-robertson Jun 4, 2024
3090af9
Pass on psychrometrics.rb.
shorowit Jun 4, 2024
c4faa50
Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML int…
shorowit Jun 4, 2024
1b18267
A little more.
shorowit Jun 5, 2024
d2e0919
Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML int…
shorowit Jun 5, 2024
19c03c7
Update measures
shorowit Jun 5, 2024
08d0d51
Move new step above Check HPXMLs.
joseph-robertson Jun 5, 2024
89e595f
Include measure.rb in checks.
joseph-robertson Jun 5, 2024
1d69638
Update and stub docs in measure.rb files.
joseph-robertson Jun 5, 2024
09ba7c5
Few params updates throughout.
joseph-robertson Jun 5, 2024
ada5915
Remove summary documentation test.
joseph-robertson Jun 5, 2024
5b93185
Missed update to config.
joseph-robertson Jun 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ jobs:
sudo apt update
sudo -E apt-get install -y wget unzip python3-sphinx-rtd-theme

- name: Check measures
shell: bash
run: |
out=$(openstudio tasks.rb update_measures 2>&1)
if [[ "$out" == *"RuboCop failed"* ]]; then echo "$out" && exit 1; fi
echo "Checking for file differences..."
git config --global --add safe.directory $(realpath .)
git diff --exit-code --ignore-cr-at-eol *.rb *.xml

- name: Check HPXMLs
shell: bash
run: |
Expand Down
12 changes: 12 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,18 @@ Style/ArgumentsForwarding:
Enabled: true
Style/CollectionCompact:
Enabled: true
Style/Documentation:
Exclude:
- '**/tests/*.rb'
- 'HPXMLtoOpenStudio/resources/hpxml.rb'
- 'workflow/**/*.rb'
- 'tasks.rb'
Style/DocumentationMethod:
Exclude:
- '**/tests/*.rb'
- 'HPXMLtoOpenStudio/resources/hpxml.rb'
- 'workflow/**/*.rb'
- 'tasks.rb'
Style/DocumentDynamicEvalDefinition:
Enabled: true
Style/EndlessMethod:
Expand Down
392 changes: 196 additions & 196 deletions BuildResidentialHPXML/README.md

Large diffs are not rendered by default.

580 changes: 565 additions & 15 deletions BuildResidentialHPXML/measure.rb

Large diffs are not rendered by default.

404 changes: 202 additions & 202 deletions BuildResidentialHPXML/measure.xml

Large diffs are not rendered by default.