Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ellipse docs #513

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ellipse docs #513

wants to merge 1 commit into from

Conversation

captainshar
Copy link

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!

@pllim
Copy link
Collaborator

pllim commented Jun 13, 2017

Congratulations! Do you plan to include other shapes too?

@captainshar
Copy link
Author

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.

@ejeschke
Copy link
Owner

@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.

@captainshar
Copy link
Author

Hi Eric!

Okay, sounds good. My two other suggestions are:

  1. Add some instructions about how to load an image and get to the drawing/edit mode - I had to click around for a while before finding that function in the program again.

  2. Add descriptions for the universal parameters as well - like the color and solid or dashed line.

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!

@pllim
Copy link
Collaborator

pllim commented Dec 20, 2018

@captainshar , do you wish to rebase and wrap this up? Thanks!

@captainshar
Copy link
Author

I don't have write access. Feel free to merge.

@pllim
Copy link
Collaborator

pllim commented Dec 25, 2018

@captainshar , unfortunately, there is conflict now. It needs a rebase.

@ejeschke ejeschke changed the base branch from master to main July 12, 2023 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants