feature request: non-api doc marker about docstringextensions.jl HOT 7 CLOSED

julia> using DocStringExtensions

julia> struct Internal <: DocStringExtensions.Abbreviation end
       
       const INTERNAL = Internal()
       
       DocStringExtensions.format(::Internal, buf, doc) = println(buf, "**Internal function or structure - interface may change.**\n\n# Extended help\n")
       
       is_internal(doc::Docs.DocStr) = any(x -> isa(x, Internal), doc.text)
is_internal (generic function with 1 method)

julia> """
           f(x) 
       
       $INTERNAL
       
       This function always returns 1
       
       # Example
       
       example of use of f(x)
       """
       f(x) = 1
f

help?> f
search: f fd for fma fld fld1 fill fdio frexp foldr foldl flush floor float first fill! fetch fldmod filter falses finally foreach fldmod1 findmin findmax findall filter!

  f(x)


  Internal function or structure - interface may change.

  ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

Extended help is available with `??`

help?> ?f
search: f fd for fma fld fld1 fill fdio frexp foldr foldl flush floor float first fill! fetch fldmod filter falses finally foreach fldmod1 findmin findmax findall filter!

  f(x)


  Internal function or structure - interface may change.

  Extended help
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  This function always returns 1

  Example
  ≡≡≡≡≡≡≡≡≡

  example of use of f(x)

julia> is_internal(Docs.@ref f(1))
true