search

CozySynthesizer / cozy

The collection synthesizer
https://cozy.uwplse.org
Apache License 2.0
209 stars 18 forks source link

refine doc about to_heap #57

Closed izgzhen closed 6 years ago

izgzhen commented 6 years ago

fixes #54

Calvin-L commented 6 years ago

The new docstring is not quite correct: the old docstring was wrong, and this one retains the old text. I would instead propose

"""Construct a heap that would be useful for evaluating `e`.

Given an EArgMin or EArgMax expression, this function produces a new
expression that constructs a heap.  Peeking the top value of the
constructed heap is semantically equivalent to evaluating `e`.
"""

I also removed the text about how the function is used; it isn't useful to readers and can easily become wrong if we decide this function is useful somewhere else.

(Also note that the first line of the docstring is on the same line as the opening """. This is a recommendation from PEP-257 that the codebase frequently breaks but I would like to start fixing.)

Calvin-L commented 6 years ago

👍