Skip to content

Fix: misleading example in etagFn documentation#91

Merged
VikramAditya33 merged 1 commit into
FOSSFORGE:mainfrom
Ashwani1405:fix-etag-doc-example
May 7, 2026
Merged

Fix: misleading example in etagFn documentation#91
VikramAditya33 merged 1 commit into
FOSSFORGE:mainfrom
Ashwani1405:fix-etag-doc-example

Conversation

@Ashwani1405
Copy link
Copy Markdown

@Ashwani1405 Ashwani1405 commented May 4, 2026

This PR fixes a misleading etagFn example in the documentation.

The previous example referenced fileContent, which is not available in the function signature and would result in a ReferenceError.

Updated the example to use file metadata (stat.size and stat.mtimeMs), which are actually available.

Also clarified that etagFn only receives fs.Stats and not file content.

Fixes #77

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 50dbb3f0-3e88-49ce-a051-6d5cac7a437d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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 and usage tips.

@VikramAditya33 VikramAditya33 self-requested a review May 4, 2026 18:49
Copy link
Copy Markdown
Collaborator

@VikramAditya33 VikramAditya33 left a comment

Choose a reason for hiding this comment

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

The example looks good to me, I've left a comment, take a look at it because I believe it kinda makes sense to me otherwise open for your view as well

Comment thread src/http/handlers/static/static-file-handler.ts Outdated
@VikramAditya33
Copy link
Copy Markdown
Collaborator

Also CI prettier tests are failing, please take a look at those too

@Ashwani1405 Ashwani1405 force-pushed the fix-etag-doc-example branch from 8b2cc2a to 198e233 Compare May 4, 2026 19:27
@VikramAditya33 VikramAditya33 self-requested a review May 4, 2026 19:34
@VikramAditya33
Copy link
Copy Markdown
Collaborator

LGTM, Thank you, could you squash your commits into one?

@Ashwani1405 Ashwani1405 force-pushed the fix-etag-doc-example branch from 198e233 to a418d7d Compare May 4, 2026 19:40
@Ashwani1405
Copy link
Copy Markdown
Author

Squashed commits into one as requested. Thanks!

@FOSSFORGE FOSSFORGE deleted a comment from coderabbitai Bot May 5, 2026
@FOSSFORGE FOSSFORGE deleted a comment from coderabbitai Bot May 5, 2026
@VikramAditya33
Copy link
Copy Markdown
Collaborator

Please link the issue in the PR description properly.

@Ashwani1405 Ashwani1405 changed the title docs: fix misleading etagFn documentation example Fixes #77 This PR fixes a misleading example in etagFn documentation by removing the invalid reference to fileContent and using file metadata instead. May 5, 2026
@VikramAditya33 VikramAditya33 changed the title Fixes #77 This PR fixes a misleading example in etagFn documentation by removing the invalid reference to fileContent and using file metadata instead. Fix: misleading example in etagFn documentation May 6, 2026
@VikramAditya33
Copy link
Copy Markdown
Collaborator

LGTM, Thank you

@VikramAditya33 VikramAditya33 merged commit 2e70fef into FOSSFORGE:main May 7, 2026
4 checks passed
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.

Fix misleading etagFn documentation example

2 participants