-
Notifications
You must be signed in to change notification settings - Fork 22
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
Some small examples to start with in README.md #245
Conversation
Codecov Report
@@ Coverage Diff @@
## master #245 +/- ##
=======================================
Coverage 75.38% 75.38%
=======================================
Files 5 5
Lines 459 459
=======================================
Hits 346 346
Misses 113 113 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems fine in principle, but I'd tweak some phrasing. And of course this does not replace a proper manual, where we explain e.g. more about what conversions are possible, and also explain background, e.g. why we don't convert everything automatically.
(Of course I am not asking you to write that manual here -- the change request is purely for some phrasing in you PR). |
4e3abe1
to
beb0fd0
Compare
I see. I applied your suggests :) |
README.md
Outdated
julia> x = GAP.julia_to_gap([1,2,3]) | ||
GAP: [ 1, 2, 3 ] | ||
``` | ||
Converting back to Julia is done using `GAP.gap_to_julia`. However, for this one needs to specify the desired type of the resulting object. For example, to convert the GAP list of integers we just defined back to Julia, we might do this: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this one long line, while lines 29/30 is wrapped?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think because you made this line longer because of your suggestions ;). Anyway, fixed it.
README.md
Outdated
``` | ||
one may call any GAP function by prefixing its name with `GAP.Globals.`. For example: | ||
```julia | ||
julia> GAP.Globals.SymmetricGroup( 3 ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not going to request a change for this, but I note that once more, this is formatted differently in terms of whitespace than the other example inputs :-).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still fixed it.
beb0fd0
to
d2e2b77
Compare
No description provided.