Skip to content

Commit 43e72f8

Browse files
committed
Clarify merge docstring
Considering this is loaded as part of REPL, not specifying that `Face` comes from `StyledStrings` can make the docstring a bit confusing to those not familiar with the stdlib. Reported-by: Michael Abbott <[email protected]>
1 parent d0f48fc commit 43e72f8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/faces.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -503,10 +503,11 @@ withfaces(f) = f()
503503
## Face combination and inheritance ##
504504

505505
"""
506-
merge(initial::Face, others::Face...)
506+
merge(initial::StyledStrings.Face, others::StyledStrings.Face...)
507507
508-
Merge the properties of the `initial` face and `others`, with
509-
later faces taking priority.
508+
Merge the properties of the `initial` face and `others`, with later faces taking priority.
509+
510+
This is used to combine the styles of multiple faces, and to resolve inheritance.
510511
"""
511512
function Base.merge(a::Face, b::Face)
512513
if isempty(b.inherit)

0 commit comments

Comments
 (0)