earthaccess icon indicating copy to clipboard operation
earthaccess copied to clipboard

Replace docstring "Placeholder" text

Open mfisher87 opened this issue 1 year ago • 2 comments

Recently, we added placeholder subject lines to docstrings which lacked subject lines but contained other data, like parameter annotations or return annotation. We needed to do this because:

  • the code formatter didn't understand this situation and would try to fix it by bringing the "Returns:" line to the subject, and
  • this would cause the docs to no longer correctly render the return type

We need to replace "Placeholder" with a real subject line for each of those functions/classes.

mfisher87 avatar Jun 11 '24 15:06 mfisher87

Should we replace the placeholder with a brief description of purpose of the function?

Sherwin-14 avatar Sep 21 '24 14:09 Sherwin-14

Yes, exactly :)

mfisher87 avatar Sep 21 '24 18:09 mfisher87