mack icon indicating copy to clipboard operation
mack copied to clipboard

Add docstrings for the methods!!

Open souvik-databricks opened this issue 2 years ago • 4 comments

Add docstrings to the functions so that the function description and parameter descriptions show up for the users when they use help() on the functions of mack.

And also gives us the ability to use Auto documentation tools like Sphinx.

souvik-databricks avatar Dec 20 '22 13:12 souvik-databricks

@souvik-databricks - yep, I like this suggestion!

MrPowers avatar Dec 20 '22 13:12 MrPowers

@MrPowers You can assign this to me.

souvik-databricks avatar Dec 22 '22 07:12 souvik-databricks

@MrPowers @robertkossendey once the latest PR of mine goes through I will start this docstrings work. However, I am curious to know your thoughts about setting up a docs page(sphinx)?

souvik-databricks avatar Dec 29 '22 04:12 souvik-databricks

@souvik-databricks - we have a small public-facing API so we might not need a separate docs page just yet. It's worth considering. We should certainly add the type requirements for each parameter of the public interface. Let's jump on a call and brainstorm the highest value add stuff we can do for our users. Building out the functionality is just the first step. Helping our users deploy mack in production is the real goal 🚀

MrPowers avatar Dec 29 '22 14:12 MrPowers