Following up on some of the positive suggestions in a recent thread , I’d like to use this thread to coordinate efforts with anyone who feels Julia’s function-level documentation can be better. Discourse lacks the ability to create a user-extensible poll, so please: Suggest functions whose document…

Yes, this is a tactical attempt to make rapid, iterative progress on the documentation. I’m open to more strategic re-evaluations, but I’m not clear there’s someone ready to take on the task of writing a large body of fully new documents about Julia. If you’re up for it, I think it would be extremel…

@printf I miss an example how to print into a string. Well, you can use an IO buffer, but how?

You have to use @sprintf , whose docstring already shows such an example, here is another simple one: julia> using Printf julia> @sprintf "%08.5f" pi "03.14159"

Agreed, a body of brand new documents is a big ask. I have given it some thought, and may be what may begin to address this is a good index. I will sketch something out.

It is substantially less clear, but you do this in steps using @printf: julia> using Printf julia> io = IOBuffer(); julia> @printf(io, "%08.5f", pi) julia> String(take!(io)) "03.14159" This is very close to an example in the documentation for take!.

Hey John, Quick question - how do I contribute to the repo you created? Thanks! ~ tcp :deciduous_tree:

The repo is only meant to track project management for improving the docs. Contributions could include: Editing the CSV file tracking functions that need doc changes. Opening an issue to ask someone to change the CSV file. Opening an issue to propose doc changes with just the text you’d like to se…

Ope - I totally missed the CSV link and the CSV in the repo after reading the README. Thanks!

[image] giordano: You have to use @sprintf Well, but this is not mentioned in the docu of @printf… So there should be a sentence added: “If you want to print into a string, use @sprintf” …

Just a thought: you could try to form a workgroup / taskforce for this which, for example, could meet once a month. Maybe there are some folks willing to participate in this effort and just need a structured environment to do so.

Coordinating community efforts to enrich function docs

General Usage

antoine-levitt May 2, 2022, 7:06am 38

I opened a new thread to try and figure out how to get people to contribute more easily, would be great if people here could chime in there :

1 Like

Topic		Replies	Views
Non-friendly documentation New to Julia question , documentation	137	9356	September 18, 2020
Some thoughts on improving basic function documentation General Usage documentation	51	2364	October 21, 2024
The challenges of documenting generic functions General Usage documentation	24	1476	August 29, 2023
Blog post about my experiences with Julia Community	259	16951	June 19, 2022
Documenter.jl: How to avoid repetitions of shared docstrings? General Usage documenter	11	404	May 11, 2025

Coordinating community efforts to enrich function docs

Related topics