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

improve documentation of evalstr_ex, evalstr #898

Merged
merged 2 commits into from
Jun 16, 2023

Conversation

ThomasBreuer
Copy link
Member

Changing evalstr such that GAP's screen output is shown in the Julia session seems to be not possible if the libgap function GAP_EvalString is used. The return value contains strings that describe the screen output plus the return value of each command, and separating the screen output from the string that represents the return value is in general not possible. Note that the pointers to the return values are not useful here because the objects may have changed since they got created, as in the following example.

julia> GAP.evalstr_ex( "x:= []; Add(x, 1);" )
GAP: [ [ true, [ 1 ], false,, "[  ]" ], [ true,, false,, "" ] ]

In the case of functions that have a return value and cause some printing to the screen, we cannot decide which part of the 5th entry in each entry of the result of evalstr_ex belongs to the return value.
(Perhaps libgap's GAP_EvalString should be changed accordingly. The fourth position in the entries of the result is currently unused.)

- document `evalstr_ex`
- extend the documentation of `evalstr`
@codecov
Copy link

codecov bot commented Jun 15, 2023

Codecov Report

Merging #898 (b5fb2da) into master (aac723c) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #898   +/-   ##
=======================================
  Coverage   75.65%   75.65%           
=======================================
  Files          51       51           
  Lines        4115     4115           
=======================================
  Hits         3113     3113           
  Misses       1002     1002           
Impacted Files Coverage Δ
src/ccalls.jl 99.16% <ø> (ø)

... and 1 file with indirect coverage changes

@ThomasBreuer
Copy link
Member Author

Some tests got canceled because they were running out of time:

  • Julia nightly - ubuntu-latest in "GAP tests",
  • Julia 1.8 - macOS-latest in "GAP tests",
  • Julia nightly - macOS-latest in "Run tests".

src/ccalls.jl Outdated Show resolved Hide resolved
@fingolfin fingolfin enabled auto-merge (squash) June 16, 2023 12:59
@fingolfin fingolfin merged commit 4aa758d into oscar-system:master Jun 16, 2023
@ThomasBreuer ThomasBreuer deleted the TB_evalstr_ex branch June 16, 2023 13:52
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