Skip to content

Commit 2ec6397

Browse files
rambleraptorclaude
andcommitted
Docs: Require link-check skip comments on external URLs in AGENTS.md
External docs hosts rate-limit the markdown link checker, so note that external URLs in docs need a markdown-link-check-disable-next-line comment. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01V2AEta8dDFjjxotEvYnb3D
1 parent 79ab49f commit 2ec6397

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ lives under `pyiceberg/`, organized by concern rather than by engine:
5656

5757
- Large/integration libraries must be **optional extras** in `pyproject.toml`, not core `dependencies`.
5858

59+
### Documentation
60+
61+
- Any external URL mentioned in the docs should have `<!-- markdown-link-check-disable-next-line -->` on the previous line.
62+
5963
## Testing
6064

6165
- Bias towards adding tests to existing files, rather than creating new files.

0 commit comments

Comments
 (0)