Describe the bug
The docstring for MCTS.run() states the return dictionary contains two keys: candidate and score. However, the actual return value includes a third key, sequence, which is undocumented.
Relevant code:
pyaptamer/mcts/_algorithm.py
Docstring (lines 268–270):
Returns
-------
dict
Dictionary containing the final candidate sequence (`candidate`) and its
score (`score`).
Actual return (lines 312–316):
return {
"candidate": reconstructed_candidate,
"sequence": self.candidate,
"score": self.experiment.evaluate(reconstructed_candidate),
}
Expected behavior
The docstring should document all three keys:
Returns
-------
dict
Dictionary containing the reconstructed candidate sequence (`candidate`),
the raw encoded sequence (`sequence`), and its score (`score`).
Versions
0.1.0a1
Describe the bug
The docstring for
MCTS.run()states the return dictionary contains two keys:candidateandscore. However, the actual return value includes a third key,sequence, which is undocumented.Relevant code:
pyaptamer/mcts/_algorithm.pyDocstring (lines 268–270):
Actual return (lines 312–316):
Expected behavior
The docstring should document all three keys:
Versions
0.1.0a1