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

Add documentation to params.yaml #2010

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Add documentation to params.yaml #2010

merged 1 commit into from
Jun 13, 2024

Conversation

kislaykishore
Copy link
Collaborator

@kislaykishore kislaykishore commented Jun 13, 2024

Description

This will guide devs on how to add new params.
I've purposely excluded hide-shorthand and shorthand features because we are not sure whether or how they will be supported.

Link to the issue in case of a bug fix.

NA

Testing details

  1. Manual - NA
  2. Unit tests - NA
  3. Integration tests - NA

@kislaykishore kislaykishore marked this pull request as ready for review June 13, 2024 07:03
@kislaykishore kislaykishore requested a review from a team as a code owner June 13, 2024 07:03
Copy link

codecov bot commented Jun 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.85%. Comparing base (19deef4) to head (68fc7b6).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2010      +/-   ##
==========================================
+ Coverage   71.82%   71.85%   +0.03%     
==========================================
  Files          97       97              
  Lines       10636    10636              
==========================================
+ Hits         7639     7643       +4     
+ Misses       2658     2655       -3     
+ Partials      339      338       -1     
Flag Coverage Δ
unittests 71.85% <ø> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@kislaykishore kislaykishore merged commit 6add684 into master Jun 13, 2024
12 checks passed
@kislaykishore kislaykishore deleted the params-doc branch June 13, 2024 12:27
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