# "Correct" way to document methods using \`where\` in the declaration?

**URL:** <https://discourse.julialang.org/t/correct-way-to-document-methods-using-where-in-the-declaration/10943>\
**Category:** General Usage\
**Tags:** parametric-types\
**Created:** [May 16, 2018, 11:01pm UTC](https://discourse.julialang.org/t/correct-way-to-document-methods-using-where-in-the-declaration/10943 "2018-05-16T23:01:20Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![tpoisot](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tpoisot/32/19812_2.png) [@tpoisot](https://discourse.julialang.org/u/tpoisot)\
**Post date:** [May 16, 2018, 11:01pm UTC](https://discourse.julialang.org/t/correct-way-to-document-methods-using-where-in-the-declaration/10943/1 "2018-05-16T23:01:20Z")

</div>

I have a function whose declaration starts with

```julia
function union(X::T, Y::T) where {T<:BipartiteNetwork}

```

I was wondering if there is a community standard about how to write the docstring for this method? I have currently

```julia
"""
    union(X::T, Y::T) where {T<:BipartiteNetwork}

Merges two bipartite networks ...
"""
function union(X::T, Y::T) where {T<:BipartiteNetwork}

```

Are there other solutions / practices I should be aware of?

---

<div class="post-metadata">

**Author:** ![rdeits](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/rdeits/32/286_2.png) [@rdeits](https://discourse.julialang.org/u/rdeits)\
**Post date:** [May 16, 2018, 11:39pm UTC](https://discourse.julialang.org/t/correct-way-to-document-methods-using-where-in-the-declaration/10943/2 "2018-05-16T23:39:53Z")

</div>

SIGNATURES from DocStringExtensions.jl is designed to help with this: [Home · DocStringExtensions.jl](https://juliadocs.github.io/DocStringExtensions.jl/stable/)

Does that work in your case?

---

<div class="post-metadata">

**Author:** ![tpoisot](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/tpoisot/32/19812_2.png) [@tpoisot](https://discourse.julialang.org/u/tpoisot)\
**Post date:** [May 17, 2018, 3:03pm UTC](https://discourse.julialang.org/t/correct-way-to-document-methods-using-where-in-the-declaration/10943/3 "2018-05-17T15:03:55Z")

</div>

Probably! I need to look at this package more closely. Thanks!