In VS Code, I keep getting that the linter returns a “possible method call error” if I try to create an instance of a struct with fields to which I’ve added docstrings; see the below MWE where the linter doesn’t complain about Foo1 but does complain about Foo2. Is the only way to avoid this to put t…

I think the idea of a docstring is that it is one bit of text that describes the defined object independently of that definition itself (e.g. in docs or requested via the REPL). For structs fieldnames are often repeated in the docstring. You could repeat the field descriptions in comments next to th…

[Screenshot 2025-02-12 at 13.21.06] Two images to show the behaviour I mean [Screenshot 2025-02-12 at 13.21.13]

Thank you, repeating the descriptions in comments seems like a good solution for me!

Possible method call error -> docstring above struct fields

New to Julia

BdeKoning February 12, 2025, 2:07pm 4

There’s this: [ANN] AutomaticDocstrings.jl - Package Announcements - Julia Programming Language

Topic		Replies	Views
Strings between fields in struct: Why a valid code General Usage	4	265	March 19, 2024
Binding docstring to struct field General Usage	2	360	November 8, 2022
Struct docstring General Usage	0	124	July 18, 2024
Allow docstring on the right of string fields Internals & Design	3	160	February 11, 2025
Accessing docstring of a field General Usage question	7	1475	March 2, 2023

Possible method call error -> docstring above struct fields

Related topics