search

JuliaDebug / JuliaInterpreter.jl

Interpreter for Julia code
Other
162 stars 34 forks source link

Add usage documentation #587

Closed ShalokShalom closed 1 year ago

codecov[bot] commented 1 year ago

Codecov Report

Merging #587 (f5dbb90) into master (6da0b26) will increase coverage by 0.03%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #587      +/-   ##
==========================================
+ Coverage   86.63%   86.67%   +0.03%     
==========================================
  Files          12       12              
  Lines        2537     2537              
==========================================
+ Hits         2198     2199       +1     
+ Misses        339      338       -1

see 1 file with indirect coverage changes

timholy commented 1 year ago

This seems OK, but it does duplicate the docs. I go back and forth in how I feel about that. Other views?

ShalokShalom commented 1 year ago

This seems OK, but it does duplicate the docs. I go back and forth in how I feel about that. Other views?

I felt the same.

To be honest, the docs seem pretty good.

The Readme on the other hand, seems like this app is not maintained and got its last update in 1960.

So I thought I pretty it up a bit. Could possibly also be achieved otherwise.

But if you like to keep it short and tidy, I would recommend placing the documentation link a bit more obvious.

It might be just me, but I really thought this is not documented at all first, only containing the instruction to install it, and that's it.

I mean, there are projects like this, so I was quick to jump to that conclusion.