Skip to content

Conversation

madvart
Copy link
Contributor

@madvart madvart commented Aug 5, 2025

Changes Made

On the "Managing Memory Usage" page, in the "Dealing with out-of-memory (OOM) errors" section, the link to "[Resource Requests] (https://docs.getdaft.io/en/stable/core_concepts/#resource-requests)" is broken. Change it to point to "https://docs.getdaft.io/en/stable/custom-code/udfs/#resource-requests".

Related Issues

None

Checklist

  • Documented in API Docs (if applicable)
  • Documented in User Guide (if applicable)
  • If adding a new documentation page, doc is added to docs/mkdocs.yml navigation
  • Documentation builds and is formatted properly (tag @ccmao1130 for docs review)

@madvart madvart requested a review from ccmao1130 August 5, 2025 00:01
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR fixes a broken documentation link in the memory management guide. The change corrects a reference to "Resource Requests" that was pointing to a non-existent section in the core concepts documentation (../core_concepts.md#resource-requests) and updates it to point to the correct location in the UDF documentation (../custom-code/udfs.md#resource-requests).

The fix is part of the "Dealing with out-of-memory (OOM) errors" section in the memory optimization documentation, where users are guided through various troubleshooting steps. The Resource Requests section contains important information about how to request specific resources (like GPUs and memory) for User-Defined Functions (UDFs), which is directly relevant to memory management scenarios.

This appears to be a maintenance fix resulting from documentation restructuring where UDF-related content was moved or reorganized, but this particular link reference wasn't updated at the time. The change ensures continuity in the user documentation experience and maintains the logical flow of the memory troubleshooting guide.

Confidence score: 5/5

  • This PR is extremely safe to merge with no risk of breaking functionality
  • Score reflects a simple documentation link fix with no code changes or complex logic involved
  • No files require special attention as this is a single-line documentation correction

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

Copy link

codecov bot commented Aug 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.43%. Comparing base (6408543) to head (70c1710).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4901      +/-   ##
==========================================
- Coverage   79.43%   79.43%   -0.01%     
==========================================
  Files         896      896              
  Lines      125511   125511              
==========================================
- Hits        99705    99700       -5     
- Misses      25806    25811       +5     

see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ccmao1130 ccmao1130 changed the title Fixing Link to Resource Requests from Managing Memory Usage Page docs: Fixing Link to Resource Requests from Managing Memory Usage Page Aug 5, 2025
@github-actions github-actions bot added the docs label Aug 5, 2025
Copy link
Contributor

@ccmao1130 ccmao1130 left a comment

Choose a reason for hiding this comment

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

LGTM! Good catch

@ccmao1130 ccmao1130 merged commit 907d9a9 into main Aug 5, 2025
50 of 51 checks passed
@ccmao1130 ccmao1130 deleted the doc-fix-broken-link branch August 5, 2025 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants