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

Improve embedded package documentation #3537

Merged
merged 3 commits into from Oct 11, 2023
Merged

Conversation

princejha95
Copy link
Contributor

@princejha95 princejha95 commented Oct 10, 2023

Description

Closes #2326.

Readiness checklist

  • I added/updated unit tests (and they pass).
  • I added/updated integration/compatibility tests (and they pass).
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Milestone (Next), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

Merging #3537 (1227b26) into main (d1486f2) will decrease coverage by 0.66%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3537      +/-   ##
==========================================
- Coverage   75.55%   74.89%   -0.66%     
==========================================
  Files         427      427              
  Lines       27131    27131              
==========================================
- Hits        20499    20320     -179     
- Misses       5448     5600     +152     
- Partials     1184     1211      +27     
Files Coverage Δ
ferretdb/ferretdb.go 82.65% <ø> (ø)

... and 18 files with indirect coverage changes

Flag Coverage Δ
filter-false ?
filter-true 71.72% <ø> (-0.77%) ⬇️
hana-1 ?
integration 71.72% <ø> (-0.81%) ⬇️
mongodb-1 4.52% <ø> (ø)
pg-1 42.49% <ø> (-0.56%) ⬇️
pg-2 39.93% <ø> (-0.49%) ⬇️
pg-3 41.62% <ø> (-0.51%) ⬇️
postgresql-1 41.69% <ø> (-0.04%) ⬇️
postgresql-2 39.14% <ø> (-0.10%) ⬇️
postgresql-3 41.41% <ø> (-0.15%) ⬇️
sort-false 71.72% <ø> (-0.25%) ⬇️
sort-true ?
sqlite-1 41.87% <ø> (-0.06%) ⬇️
sqlite-2 39.13% <ø> (-0.03%) ⬇️
sqlite-3 40.97% <ø> (-0.02%) ⬇️
unit 25.91% <ø> (-0.08%) ⬇️

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

@AlekSi AlekSi enabled auto-merge (squash) October 10, 2023 04:29
@AlekSi AlekSi added this to the v1.12.0 milestone Oct 10, 2023
@AlekSi AlekSi added the code/chore Code maintenance improvements label Oct 10, 2023
ferretdb/ferretdb.go Outdated Show resolved Hide resolved
@AlekSi AlekSi self-assigned this Oct 10, 2023
@AlekSi AlekSi modified the milestones: v1.12.0, Next Oct 10, 2023
auto-merge was automatically disabled October 11, 2023 04:25

Head branch was pushed to by a user without write access

@AlekSi AlekSi changed the title Improve embedded ferretdb package documentation Improve embedded package documentation Oct 11, 2023
@AlekSi AlekSi enabled auto-merge (squash) October 11, 2023 06:42
@AlekSi AlekSi requested review from a team, chilagrow and noisersup October 11, 2023 06:43
@AlekSi AlekSi merged commit 9475382 into FerretDB:main Oct 11, 2023
33 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code/chore Code maintenance improvements
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Improve embedded package documentation
3 participants