From 89056b51a968da31293145e5561ddd49440d4c1d Mon Sep 17 00:00:00 2001
From: Junyuan Chen <norman.chen.git@gmail.com>
Date: Mon, 6 May 2024 14:27:05 -0700
Subject: [PATCH] Add a comment

---
 src/AbstractFixedEffectSolver.jl | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/AbstractFixedEffectSolver.jl b/src/AbstractFixedEffectSolver.jl
index c90789c..07eb5e8 100644
--- a/src/AbstractFixedEffectSolver.jl
+++ b/src/AbstractFixedEffectSolver.jl
@@ -80,6 +80,9 @@ function solve_residuals!(r::AbstractVector{<:Real}, feM::AbstractFixedEffectSol
 end
 
 # A fallback method for collections of x
+# The container for data columns does not have to be a vector
+# This allows the use of iterators and tuples for xs in downstream packages
+# See https://github.com/FixedEffects/FixedEffects.jl/pull/65
 function solve_residuals!(xs, feM::AbstractFixedEffectSolver; progress_bar = true, kwargs...)
     iterations = Int[]
     convergeds = Bool[]