# Adopt the SciML Style Guide for Julia Base and Standard Library?

**URL:** <https://discourse.julialang.org/t/adopt-the-sciml-style-guide-for-julia-base-and-standard-library/134845>\
**Category:** General Usage\
**Tags:** documentation, sciml, style\
**Created:** [January 2, 2026, 7:05pm UTC](https://discourse.julialang.org/t/adopt-the-sciml-style-guide-for-julia-base-and-standard-library/134845 "2026-01-02T19:05:04Z")\
**Posts on this page:** 1\
**Showing post:** 9

<div class="post-metadata">

**Author:** ![langestefan](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/langestefan/32/207923_2.png) [@langestefan](https://discourse.julialang.org/u/langestefan)\
**Post date:** [January 3, 2026, 1:50pm UTC](https://discourse.julialang.org/t/adopt-the-sciml-style-guide-for-julia-base-and-standard-library/134845/9 "2026-01-03T13:50:30Z")

</div>

> [@csvance](#):
>
> I’m not sure if its just because I have not dug deep enough in [Documenter.jl](https://juliaregistries.github.io/General/packages/redirect_to_repo/Documenter) or not, but at a surface level I didn’t notice a way to neatly document arguments and return types following the [Documenter.jl](https://juliaregistries.github.io/General/packages/redirect_to_repo/Documenter) guide.

It’s all handwritten markdown right now, and there is no single agreed upon format to document function arguments. That’s why, _in my opinion_, Julia API docs can feel quite messy. Each project does it differently. I frequently run into API docs that haven’t documented function arguments at all, and everything is just `Any` according to the docs (but it never is)

I did some digging a while back and found this relevant discussion: [Argument-specific docstrings or comments](https://discourse.julialang.org/t/argument-specific-docstrings-or-comments/32189), unfortunately that never got any followup.

So for now my suggestion would be to:

1. Pick a style guide you like. SciML, Blue, YAS.
2. Ensure you follow the styleguide by using JuliaFormatter.jl
3. Apply style-specific formatting using custom CSS.

---

_[View the full topic](https://discourse.julialang.org/t/adopt-the-sciml-style-guide-for-julia-base-and-standard-library/134845)._