Skip to content

docs: correct CLIENT_CACHE_MAX_SIZE unit comment to MB - #3294

Open
anxkhn wants to merge 1 commit into
Netflix:masterfrom
anxkhn:fix/client-cache-max-size-unit-comment
Open

anxkhn wants to merge 1 commit into
Netflix:masterfrom
anxkhn:fix/client-cache-max-size-unit-comment

Conversation

@anxkhn

@anxkhn anxkhn commented Jul 7, 2026

Copy link
Copy Markdown

PR Type

  • Docs / tooling

The inline comment above CLIENT_CACHE_MAX_SIZE says the value is "in bytes", but
the only consumer multiplies it by 1024**2, so the value is actually interpreted
in megabytes. This corrects the comment to "in MB". No behavior changes.

Issue

Fixes #<OPEN_ACKNOWLEDGED_ISSUE> <!-- REQUIRED: do not open the PR until this

The comment above CLIENT_CACHE_MAX_SIZE said the value is in bytes, but
the only consumer (FileCache._garbage_collect) multiplies it by 1024**2,
so the value is interpreted in megabytes. The default of 10000 is
therefore ~10 GB, consistent with the MB interpretation.

Reading the value as bytes leads operators to oversize the cap by a
factor of ~1,048,576 (for example, setting 100000000 intending ~100 MB
actually configures a ~100 TB cap), which effectively disables client
cache garbage collection. Correct the comment to state MB; no behavior
changes.

Signed-off-by: Anas Khan <83116240+anxkhn@users.noreply.github.com>
@greptile-apps

greptile-apps Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR corrects the unit label for the client cache size setting.

  • Updates the CLIENT_CACHE_MAX_SIZE comment from bytes to MB.
  • Leaves the cache default and runtime behavior unchanged.

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
metaflow/metaflow_config.py Comment-only update documenting CLIENT_CACHE_MAX_SIZE as megabytes.

Reviews (1): Last reviewed commit: "docs: correct CLIENT_CACHE_MAX_SIZE unit..." | Re-trigger Greptile

@anxkhn

anxkhn commented Aug 12, 2026

Copy link
Copy Markdown
Author

@saikonen when you have a chance, could you please take a look at this pr and let me know if any update is needed?

@Shriprasad-P Shriprasad-P left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review

PR: docs: correct CLIENT_CACHE_MAX_SIZE unit comment to MB

Touched: metaflow/metaflow_config.py

  • Small docs/comment cleanup; low risk if wording is accurate.
  • Size looks manageable (+1/-1).

Commenting as a drive-by reviewer after reading the diff. Happy to look again if maintainers want a deeper pass on a specific file.

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