Skip to content

chore(docs): fix typos in plaintext files#3716

Merged
jakedoublev merged 1 commit into
mainfrom
chore/docs-typo-polish
Jul 2, 2026
Merged

chore(docs): fix typos in plaintext files#3716
jakedoublev merged 1 commit into
mainfrom
chore/docs-typo-polish

Conversation

@jp-ayyappan

@jp-ayyappan jp-ayyappan commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fix spelling and minor grammar issues in Markdown documentation and YAML config comments
  • Keep generated docs, code, proto, scripts, and build files out of this PR

Testing

  • git diff --check origin/main...HEAD
  • uvx codespell <changed Markdown/YAML files>

@jp-ayyappan jp-ayyappan requested review from a team as code owners July 2, 2026 15:15
@github-actions github-actions Bot added comp:db DB component comp:policy Policy Configuration ( attributes, subject mappings, resource mappings, kas registry) comp:sdk A software development kit, including library, for client applications and inter-service communicati comp:authorization docs Documentation comp:examples comp:lib:fixtures labels Jul 2, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the overall quality of the codebase and documentation by addressing various typos and minor grammatical inconsistencies. It also includes minor code formatting adjustments and improvements to logging readability. The changes are strictly limited to documentation, comments, and non-functional code style, ensuring that generated files like OpenAPI/gRPC docs and SQL outputs remain untouched.

Highlights

  • Documentation and Code Cleanup: Fixed numerous spelling and grammar errors across markdown files, YAML configurations, source code comments, and test labels.
  • Code Formatting: Applied gofumpt to Go files to ensure consistent formatting.
  • Logging Improvements: Refactored several slog calls to use multi-line formatting for better readability.
New Features

🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.


A typo here, a grammar slip, We polish code with every dip. With gofumpt clean and comments bright, Our codebase shines in morning light.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR consists entirely of typo corrections in comments, documentation, and error message strings, along with reformatting of single-line slog/logger calls into multiline structured forms across multiple Go files. One functional change renames a parameter (identiferidentifier) in a KAS registry handler. No logic, control flow, or public APIs were altered.

Changes

Typo Fixes and Log Formatting Cleanup

Layer / File(s) Summary
Documentation and config comment typos
Dockerfile, adr/decisions/*, docs/Contributing-errors.md, opentdf-*-mode.yaml, otdfctl/docs/man/..., service/policy/adr/*, service/policy/objects.proto, service/integration/wiremock/README.md
Spelling and wording corrections in comments, ADRs, YAML headers, and CLI man pages with no functional change.
Examples CLI logging cleanup
examples/cmd/attributes.go
Reformats slog.Error/slog.Info calls to multiline structured form and fixes "attibute" typos in error messages.
Keycloak fixtures logging cleanup
lib/fixtures/keycloak.go
Reformats slog calls and corrects log wording in realm role fetch and cert exchange flows.
KAS registry handler rename
otdfctl/pkg/handlers/kas-registry.go, otdfctl/e2e/registered-resources.bats
Renames GetKasRegistryEntry parameter from identifer to identifier and updates usages; fixes a related test comment typo.
SDK granter logging and errors
sdk/granter.go, sdk/granter_test.go
Reformats debug/warn logs into structured multiline calls and corrects "no defintion" typo; test description typos fixed.
SDK core error/comment fixes
sdk/options.go, sdk/resource_locator.go, sdk/tdf.go, sdk/tdf_config.go
Corrects error message and comment typos with no behavior change.
Authorization logging and test reformatting
service/authorization/authorization.go, service/authorization/authorization_test.go, service/authorization/authorization_test_structures.go
Reformats rego eval/logging calls to multiline form, corrects comments, and updates rego.Module call formatting across many tests.
Entity resolution logging cleanup
service/entityresolution/keycloak/*
Reformats logger.DebugContext calls into multiline form and corrects comment wording.
Policy/server/db/logger misc fixes
service/policy/db/obligations.go, service/internal/access/pdp.go, service/logger/logger.go, service/pkg/db/errors.go, service/pkg/server/start.go, service/policy/namespaces/namespaces_test.go, service/integration/*, service/policy/resourcemapping/resource_mapping_test.go
Corrects comment and error-message typos and reformats one slog call, with no logic changes.

Estimated code review effort: 2 (Simple) | ~15 minutes

Poem

Hop, hop, through the code we go,
Fixing typos row by row,
"defintion" now reads clean and bright,
Logs stretched neat across the night,
No logic bent, no bug set free—
Just tidy words for you and me. 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change—typo fixes—but slightly understates that the PR also updates Go comments and strings.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-typo-polish

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the size/m label Jul 2, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request primarily addresses numerous typos in comments, documentation, and string literals across the codebase, while also standardizing the formatting of multi-line function calls and logging statements. The code review identified two valid issues: a potential nil pointer dereference in the entity resolution service when handling payload elements, and an ineffective log statement in the authorization service that logs an empty string instead of the invalid entitlement value when type assertion fails.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread service/entityresolution/keycloak/v2/entity_resolution.go Outdated
Comment thread service/authorization/authorization.go Outdated
jakedoublev
jakedoublev previously approved these changes Jul 2, 2026

@jakedoublev jakedoublev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔥

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor
Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 209.775343ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 108.514999ms

Benchmark Statistics

Name № Requests Avg Duration Min Duration Max Duration

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 427.178021ms
Throughput 234.09 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 47.125837987s
Average Latency 468.720834ms
Throughput 106.10 requests/second

Signed-off-by: jp-ayyappan <jp@as2max.com>
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor
Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 203.610305ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 102.457246ms

Benchmark Statistics

Name № Requests Avg Duration Min Duration Max Duration

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 466.852496ms
Throughput 214.20 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 45.869558291s
Average Latency 456.287932ms
Throughput 109.00 requests/second

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

⚠️ Govulncheck found vulnerabilities ⚠️

The following modules have known vulnerabilities:

  • examples
  • otdfctl
  • sdk
  • service
  • lib/fixtures
  • tests-bdd

See the workflow run for details.

@jakedoublev jakedoublev added this pull request to the merge queue Jul 2, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 2, 2026
@jakedoublev jakedoublev added this pull request to the merge queue Jul 2, 2026
Merged via the queue into main with commit 1a81221 Jul 2, 2026
47 checks passed
@jakedoublev jakedoublev deleted the chore/docs-typo-polish branch July 2, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp:authorization comp:db DB component comp:examples comp:lib:fixtures comp:policy Policy Configuration ( attributes, subject mappings, resource mappings, kas registry) comp:sdk A software development kit, including library, for client applications and inter-service communicati docs Documentation size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants