Docs?

[oxinabox]

It would be nice to have a basic readme.

[ZacLN]

I'm doing a write up for a talk in a week or so, which I'll then put online

[oxinabox]

@ZacLN link?

[aviks]

Hi, another request for a basic readme. At the very least, documenting the entry points for standalone use would be very useful.

[s-celles]

I'm also looking for such a doc (or at least README.md).

What functions should be called from Julia

• for linting an entire package
• for linting a file
• for linting a string

Is there a CLI to be able to lint a package or a file "directly" from Bash?
(similar to julia-vscode/DocumentFormat.jl#34 )

[TeroFrondelius]

I spent few hours to learn this package internals. I got so far that I copied the test and got the linting working but I couldn't figure out how to print/display anything meaningful.

[aminya]

@davidanthoff @ZacLN
Any update on this? Could you give us the code that lints a simple file? Something like the following:

lint_file("test.jl")

[twolodzko]

I'm bumping this thread since have similar question as @aminya and @scls19fr. Could you share a basic usage example? If I understood the ideas behind this package better I could even help with creating a PR with improved documentation, but I would prefer to start by someone commenting what is the intended usage, rather than figuring it myself from the code.

[oxinabox]

I think the thing that would be most useful for the docs would be to have a little example script that
takes a filepath, loads the files, lints them, and prints all warnings to the screen.

I feel like that would make it clear how all the parts fit together

[aminya]

I added convenient functions that do everything for you in:
#220

But there has been zero interest from the developers of this repo for reviewing the PR

[TeroFrondelius]

But there has been zero interest from the developers of this repo for reviewing the PR

Maybe you should ping some of them in the pull request. Nice work by the way, I was missing those functions when I tried to use this repo.