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

docs: Rename _key to _docID in docs #2989

Merged

Conversation

ONLYUSEmePHONE
Copy link
Contributor

Relevant issue(s)

Resolves #2977

Description

This PR renames occurrences of _key to _docID when using schemas in the project's markdown documentation.

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
  • I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Github markdown preview

Specify the platform(s) on which this was tested:

  • Debian Linux

@shahzadlone
Copy link
Member

shahzadlone commented Sep 9, 2024

todo: Please change the PR title's leading label from fix: ... to docs: ...

@ONLYUSEmePHONE ONLYUSEmePHONE changed the title fix: rename _key to _docID in docs docs: rename _key to _docID in docs Sep 9, 2024
Copy link
Member

@shahzadlone shahzadlone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thank you very much for these changes

Your validation workflow is failing because the first letter after the docs: label must be a capital letter

Copy link

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.30%. Comparing base (04531c3) to head (e17731d).
Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2989      +/-   ##
===========================================
+ Coverage    79.27%   79.30%   +0.03%     
===========================================
  Files          328      328              
  Lines        25207    25207              
===========================================
+ Hits         19982    19989       +7     
- Misses        3788     3789       +1     
+ Partials      1437     1429       -8     
Flag Coverage Δ
all-tests 79.30% <ø> (+0.03%) ⬆️

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

see 14 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 04531c3...e17731d. Read the comment docs.

@ONLYUSEmePHONE ONLYUSEmePHONE changed the title docs: rename _key to _docID in docs docs: Rename _key to _docID in docs Sep 9, 2024
@shahzadlone shahzadlone merged commit 44ee5cd into sourcenetwork:develop Sep 9, 2024
40 of 44 checks passed
ChrisBQu pushed a commit to ChrisBQu/defradb that referenced this pull request Feb 21, 2025
## Relevant issue(s)

Resolves sourcenetwork#2977 

## Description

This PR renames occurrences of _key to _docID when using schemas in the
project's markdown documentation.

## Tasks

- [ ] I made sure the code is well commented, particularly
hard-to-understand areas.
- [x] I made sure the repository-held documentation is changed
accordingly.
- [x] I made sure the pull request title adheres to the conventional
commit style (the subset used in the project can be found in
[tools/configs/chglog/config.yml](tools/configs/chglog/config.yml)).
- [ ] I made sure to discuss its limitations such as threats to
validity, vulnerability to mistake and misuse, robustness to
invalidation of assumptions, resource requirements, ...

## How has this been tested?

Github markdown preview

Specify the platform(s) on which this was tested:
- Debian Linux
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.

Getting Started doc broken on create a document
2 participants