chore: delete stale variable-name NOTE/TODO from Formula::get doxygen#38
Draft
hozblok wants to merge 1 commit into
Draft
chore: delete stale variable-name NOTE/TODO from Formula::get doxygen#38hozblok wants to merge 1 commit into
hozblok wants to merge 1 commit into
Conversation
The comment claimed variables must be single Latin letters a..z and i.
That is contradicted by tests/test_simple.py::test_getting_variables,
which exercises multi-character ('qwe', 'xx', 's_s_s.') and Cyrillic
('йцу4') variable names today. The constraint is fictional; drop the
NOTE and the 'TODO: why so?' that questioned it.
Doc-only. No code or tests changed.
Closes TODO src/cpp/csformula/csformula.hpp:187.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes TODO
src/cpp/csformula/csformula.hpp:187(* number. TODO: why so?).Problem
The doxygen block on
Formula::getcarried a NOTE claiming variables must be single Latin lettersa..zandi, followed byTODO: why so?questioning the constraint.The constraint is fictional —
tests/test_simple.py::test_getting_variablesalready passes with multi-character names (qwe,xx,s_s_s.) and Cyrillic names (йцу4). The parser accepts them; the NOTE was wrong.Change
Delete the NOTE and the trailing TODO. The remaining sentence ("Get the calculated value of the formula in accordance with the 'map_variable_values' dictionary…") stands on its own.
Doc-only. No code or tests changed. Full suite 388/388, 3 xfailed unchanged.