Skip to content

Commit c4d6089

Browse files
committed
remove docstring but add some code comments
1 parent 4ee4eb7 commit c4d6089

File tree

1 file changed

+4
-116
lines changed

1 file changed

+4
-116
lines changed

src/DataAPI.jl

+4-116
Original file line numberDiff line numberDiff line change
@@ -183,128 +183,16 @@ default definition.
183183
function unwrap end
184184
unwrap(x) = x
185185

186-
const _joindoc = """
187-
The implementation specific arguments, like the join key or equality rule,
188-
can be designed as the additional keyword arguments.
189-
"""
190-
191-
"""
192-
innerjoin(x, y)
193-
194-
Perform a database-style inner join of two tabular objects and return a tabular
195-
object containing the result.
196-
197-
$_joindoc
198-
199-
See also: [`outerjoin`](@ref),
200-
[`leftjoin`](@ref),
201-
[`rightjoin`](@ref),
202-
[`semijoin`](@ref),
203-
[`antijoin`](@ref),
204-
[`crossjoin`](@ref).
205-
"""
186+
# The database-style join methods for tabular data type.
187+
# The common interface is `*join(x, y; ...)` and use the keyword arguments
188+
# for the join criteria.
189+
# See the design of DataFrames.jl also.
206190
function innerjoin end
207-
208-
"""
209-
outerjoin(x, y)
210-
211-
Perform a database-style outer join of two tabular objects and return a tabular
212-
object containing the result.
213-
214-
$_joindoc
215-
216-
See also: [`innerjoin`](@ref),
217-
[`leftjoin`](@ref),
218-
[`rightjoin`](@ref),
219-
[`semijoin`](@ref),
220-
[`antijoin`](@ref),
221-
[`crossjoin`](@ref).
222-
"""
223191
function outerjoin end
224-
225-
"""
226-
rightjoin(x, y)
227-
228-
Perform a database-style right join on two tabular objects and return a tabular
229-
object containing the result.
230-
231-
$_joindoc
232-
233-
See also: [`innerjoin`](@ref),
234-
[`outerjoin`](@ref),
235-
[`leftjoin`](@ref),
236-
[`semijoin`](@ref),
237-
[`antijoin`](@ref),
238-
[`crossjoin`](@ref).
239-
"""
240192
function rightjoin end
241-
242-
"""
243-
leftjoin(x, y)
244-
245-
Perform a database-style left join of two tabular objects and return a tabular
246-
object containing the result.
247-
248-
$_joindoc
249-
250-
See also: [`innerjoin`](@ref),
251-
[`outerjoin`](@ref),
252-
[`rightjoin`](@ref),
253-
[`semijoin`](@ref),
254-
[`antijoin`](@ref),
255-
[`crossjoin`](@ref).
256-
"""
257193
function leftjoin end
258-
259-
"""
260-
semijoin(x, y)
261-
262-
Perform a database-style semi join of two tabular objects and return a tabular
263-
object containing the result.
264-
265-
$_joindoc
266-
267-
See also: [`innerjoin`](@ref),
268-
[`outerjoin`](@ref),
269-
[`leftjoin`](@ref),
270-
[`rightjoin`](@ref),
271-
[`antijoin`](@ref),
272-
[`crossjoin`](@ref).
273-
"""
274194
function semijoin end
275-
276-
"""
277-
antijoin(x, y)
278-
279-
Perform a database-style anti join of two tabular objects and return a tabular
280-
object containing the result.
281-
282-
$_joindoc
283-
284-
See also: [`innerjoin`](@ref),
285-
[`outerjoin`](@ref),
286-
[`leftjoin`](@ref),
287-
[`rightjoin`](@ref),
288-
[`semijoin`](@ref),
289-
[`crossjoin`](@ref).
290-
"""
291195
function antijoin end
292-
293-
"""
294-
crossjoin(x, y)
295-
296-
Perform a database-style cross join of two tabular objects and return a tabular
297-
object containing the result.
298-
299-
$_joindoc
300-
301-
See also: [`innerjoin`](@ref),
302-
[`outerjoin`](@ref),
303-
[`leftjoin`](@ref),
304-
[`rightjoin`](@ref),
305-
[`semijoin`](@ref),
306-
[`antijoin`](@ref).
307-
"""
308196
function crossjoin end
309197

310198
end # module

0 commit comments

Comments
 (0)