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

Add section on Deform to manual #46

Merged
merged 3 commits into from
Feb 11, 2014
Merged

Add section on Deform to manual #46

merged 3 commits into from
Feb 11, 2014

Conversation

bergey
Copy link
Member

@bergey bergey commented Feb 9, 2014

Here's some documentation to accompany diagrams/diagrams-lib#148 It at least explains the aspects of what's Deformable that gave me headaches writing the code.

Is there a way to mark up Transformations that will be linked correctly? Sometimes the plural is correct in the sentence, but when I place backticks in the obvious place, the .rst parsing shows them in the output HTML, and there's no link.

@byorgey
Copy link
Member

byorgey commented Feb 9, 2014

Yes, to mark up Transformations you need to put a backslash before the s. It doesn't make much sense to me but it works.

`d \times d`:math: matrices.
`d \times d`:math: matrices. More general, non-affine
transformations, including projective transformations, are referred to
in ``diagrams`` as `Deformations`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing a final period.

@byorgey
Copy link
Member

byorgey commented Feb 9, 2014

Might also be nice to include a few example diagrams. Looks good to me other than that.

@bergey
Copy link
Member Author

bergey commented Feb 11, 2014

I added a simple example. I want to add a more interesting example projecting 3D to 2D, but I need to write the code to support that first.

byorgey added a commit that referenced this pull request Feb 11, 2014
Add section on Deform to manual
@byorgey byorgey merged commit 56f82a8 into master Feb 11, 2014
@byorgey byorgey deleted the deform branch February 11, 2014 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants