From cfd0693ae52c2444ce23ee8409d1df033a3fd001 Mon Sep 17 00:00:00 2001
From: Martin Fischer <martin@push-f.com>
Date: Wed, 1 Feb 2023 06:47:22 +0100
Subject: [PATCH] refactor: Document internal test_path function

---
 src/test.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/test.rs b/src/test.rs
index 07c6986144..bee3d8901e 100644
--- a/src/test.rs
+++ b/src/test.rs
@@ -15,6 +15,8 @@ use crate::{
     source_code::{Indexer, Locator, Stylist},
 };
 
+/// A convenient wrapper around [`check_path`], that additionally
+/// asserts that autofixes converge after 10 iterations.
 pub fn test_path(path: &Path, settings: &Settings) -> Result<Vec<Diagnostic>> {
     let contents = fs::read_file(path)?;
     let tokens: Vec<LexResult> = rustpython_helpers::tokenize(&contents);