[Documentation]: Should we add Returns section to the docstrings of our get methods (get_metadata, etc.)

[pauladkisson]

See #1063

Code of Conduct

• I agree to follow this project's Code of Conduct
• Have you ensured this bug was not already reported?

[pauladkisson]

On the one hand, documentation = good, OTH simple 1-liners usually suffice to convey all the relevant info.

[h-mayorquin]

I am leaning toward yes as in most cases implementing them at the base interface should work for most cases so it is not a lot of work. Plus, is a uniform rule, everything should have arguments and returns...

[h-mayorquin]

@pauladkisson is your preference for yes? I think that the other team members do not have a preference so if you have this one we can just start moving slowly towards it as I don't have a strong one either.

[pauladkisson]

Yeah, let's do it. It will be more consistent with all the other docstrings.

[h-mayorquin]

Maybe seeing if it can add this is a good test bed for Cline capabilities?

[pauladkisson]

Maybe seeing if it can add this is a good test bed for Cline capabilities?

Yeah, good idea! It's a simple request/easy to validate, but requires keeping track of a lot of files, which has been a failure point for agents in my experience. Do we have a CN API key? It might be a larger job.