Conversation
|
Congratulations! Do you plan to include other shapes too? |
|
If you like what I did with the ellipse I can add similar sections for the other shapes - but I can't promise how quickly I will get to it. (I'm in the middle of moving to California.) Let me know if you would like me to keep this PR open for a while for the other shapes, or do you want to merge this one now, since I don't know when I'll have more time to work on this? At Write the Docs, our project leader mentioned being able to extrapolate sections for the other shapes if I wrote one of them. |
|
@captainshar, congratulations on the new job! Guess that conference was well worth it. I'm going to consider this PR a bit, and may modify it a bit before merging. It is definitely toward what I have in mind for the shapes. You may remember a couple of talks at the conference about generating the docs from the code--I'd kind of like to generate the docs for each canvas item from the get_params_metadata() method in each canvas type, since that already has the descriptions, default values, etc. What I may do is merge your descriptions and combine the above auto-generation with your approach of showing an example for each shape. |
|
Hi Eric! Okay, sounds good. My two other suggestions are:
Feel free to ping me again in about 6 weeks - I will hopefully be more settled in San Fran and may have more bandwidth to contribute. Cheers! |
|
@captainshar , do you wish to rebase and wrap this up? Thanks! |
|
I don't have write access. Feel free to merge. |
|
@captainshar , unfortunately, there is conflict now. It needs a rebase. |
Let me know if this is what you were thinking for documenting the canvas features!
Also - thank you so much for helping with that Kubernetes pull request at Write the Docs. One thing led to another, and now I've got a job at Google! So thank you!