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

[DOP-13156] Documentation improvements #79

Merged
merged 1 commit into from
Feb 15, 2024
Merged

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented Feb 15, 2024

Change Summary

  • Added third-party HWM Store links to Readme, like YAMLHWMStore in onETL and HorizonHWMStore
  • Added documentation for HWMStoreStackManager and HWMStoreClassRegistry methods
  • Fixed old examples in HWMTypeRegistry methods
  • Updated example of @detect_hwm_store
  • Renamed HWMStoreClassRegistry.known_types to aliases, new name should be more descriptive. This is breaking change, but really nobody calls this method explicitly.
  • Moved nesting from HWM and HWM Store sections of menu:
Before

image

After

image

See https://etl-entities--79.org.readthedocs.build/en/79/

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@dolfinus dolfinus self-assigned this Feb 15, 2024
Copy link

codecov bot commented Feb 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (94b4af0) 96.45% compared to head (0053679) 96.45%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop      #79   +/-   ##
========================================
  Coverage    96.45%   96.45%           
========================================
  Files           50       50           
  Lines         1129     1129           
  Branches       202      202           
========================================
  Hits          1089     1089           
  Misses          23       23           
  Partials        17       17           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dolfinus dolfinus merged commit 6ba6262 into develop Feb 15, 2024
15 checks passed
@dolfinus dolfinus deleted the feature/DOP-13156 branch February 15, 2024 15:40
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.

None yet

2 participants