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 missing example #5

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

Conversation

eschnett
Copy link

No description provided.

Comment on lines +179 to +180
julia> @basis 3 S b
(⟨+++⟩, v, v₁, v₂, v₃, v₁₂, v₁₃, v₂₃, v₁₂₃)
Copy link
Owner

Choose a reason for hiding this comment

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

An example is already given a few lines above that
https://github.com/chakravala/DirectSum.jl/blame/c72c52cdfa3e46a9565a53aee2c06e82db407609/README.md#L158

It may have been easy to miss because it is on the same line as using statement.

julia> using DirectSum; @basis^3 # equivalent to basis"+++"
(⟨+++⟩, v, v₁, v₂, v₃, v₁₂, v₁₃, v₂₃, v₁₂₃)

I don't want the same example twice, but perhaps, instead of adding a second example, the original one should be moved to a new line to make it more clear.

Copy link
Author

Choose a reason for hiding this comment

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

The missing example is for the syntax to give custom names to the vector space and basis vectors (S, b). This is mentioned in the first half of the preceding paragraph. Instead of having both examples together, the paragraph could be split into two, and the example in between the two halves.

Copy link
Owner

@chakravala chakravala Apr 23, 2020

Choose a reason for hiding this comment

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

Aha, well the README is not supposed to be a comprehensive manual, which is why I intentionally truncated it from what's in the documentation website. It's only supposed to give some teasers and a general impression, while documuntation website is supposed to contain what will eventually be the full manual.

If you would like to add more details for a more complete manual, it would be better to submit it to the documentation web page instead of the README.

Copy link
Author

Choose a reason for hiding this comment

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

That's fine. However, since the paragraph above my new example explicitly says:

"In the following command, the @basis macro arguments are used to assign the vector space name to S instead of V and basis elements to b instead of v, so that their local names do not interfere."

... I thought that the following command should actually do that.

Copy link
Owner

Choose a reason for hiding this comment

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

Good point. At the moment I'm unsure, but maybe that sentence needs to be deleted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants