search

JuliaText / TextAnalysis.jl

Julia package for text analysis
Other
373 stars 95 forks source link

Add API documentation #147

Closed aquatiko closed 5 years ago

aquatiko commented 5 years ago

I have added the documentation from source docs and the original comments mentioned in the file. Here I have added API docs only for documents.jl file. It's a bit long task to do for all the exported functions, I will be adding them gradually.

Closes: https://github.com/JuliaText/TextAnalysis.jl/issues/146

cchderrick commented 5 years ago

I think examples that meant to run in repl can be formatted like this

```julia-repl
julia> sd = StringDocument(str)
    StringDocument{String}("To be or not to be...", TextAnalysis.DocumentMetadata(Languages.English(), "Untitled Document", "Unknown Author", "Unknown Time"))
aquatiko commented 5 years ago

Oh! thnx for the tip I wasn't quite aware of this feature...

Ayushk4 commented 5 years ago

Adding DocStrings to the remaining files done in #150 . :tada:

aquatiko commented 5 years ago

@aviks This PR is complete from my side. Needs reviews from you..

aviks commented 5 years ago

Hi @aquatiko this looks good, but there is unfortunately a conflict. Could you resolve that please?

aquatiko commented 5 years ago

Done @aviks