Skip to content

Commit fe3fb10

Browse files
authored
Apply suggestions from code review
1 parent ee417ce commit fe3fb10

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

src/event_handler.jl

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,14 @@ function eventexec(event::T) where {T<:AbstractEventhdlr}
2020
end
2121

2222
"""
23-
Virtual function for eventinit. By default it does nothing
23+
Default eventinit function.
2424
"""
25-
function eventinit(event::T) where {T<:AbstractEventhdlr}
26-
return
27-
end
25+
function eventinit(event::AbstractEventhdlr) end
2826

2927
"""
30-
Virtual function for eventexit. By default it does nothing
28+
Default eventexit function.
3129
"""
32-
function eventexit(event::T) where {T<:AbstractEventhdlr}
33-
return
34-
end
30+
function eventexit(event::AbstractEventhdlr) end
3531
"""
3632
This is the function that will be converted to a C function. It signature
3733
matches the one given in the SCIP documentation for SCIP_DECL_EVENTEXEC.
@@ -54,8 +50,8 @@ function _eventexec(
5450
end
5551

5652
"""
57-
This is the function that will be converted to a C function. It signature
58-
matches the one given in the SCIP documentation for SCIP_DECL_EVENTINIT.
53+
Internal function that will be converted to a C function and passed to SCIP as a callback.
54+
Its signature matches the one given in the SCIP documentation for `SCIP_DECL_EVENTINIT`.
5955
"""
6056
function _eventinit(
6157
scip::Ptr{SCIP_},
@@ -71,10 +67,9 @@ function _eventinit(
7167
end
7268

7369
"""
74-
This is the function that will be converted to a C function. It signature
75-
matches the one given in the SCIP documentation for SCIP_DECL_EVENTEXIT.
70+
Internal function that will be converted to a C function passed to SCIP.
71+
Its signature matches the one given in the SCIP documentation for `SCIP_DECL_EVENTEXIT`.
7672
"""
77-
7873
function _eventexit(
7974
scip::Ptr{SCIP_},
8075
eventhdlr::Ptr{SCIP_Eventhdlr},

0 commit comments

Comments
 (0)