Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API documentation #147

Merged
merged 11 commits into from
Jun 15, 2019
Merged

Add API documentation #147

merged 11 commits into from
Jun 15, 2019

Conversation

aquatiko
Copy link
Contributor

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: #146

@cchderrick
Copy link
Contributor

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
Copy link
Contributor Author

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

@laschuet laschuet mentioned this pull request Apr 26, 2019
Copy link
Member

@Ayushk4 Ayushk4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rohit, thank you so much for the newly add docstrings to hash.jl and dtm.jl.

I feel that some changes could be made for the newly added docs to dtm.jl, hash.jl . (Refer - https://docs.julialang.org/en/v1/manual/documentation/index.html )

Also, I feel that a separate argument list explanation shouldn't be necessary for each function. (See Point 4. in the link above).

src/dtm.jl Outdated Show resolved Hide resolved
src/dtm.jl Outdated Show resolved Hide resolved
src/dtm.jl Outdated Show resolved Hide resolved
src/dtm.jl Outdated Show resolved Hide resolved
src/dtm.jl Outdated Show resolved Hide resolved
@Ayushk4
Copy link
Member

Ayushk4 commented May 14, 2019

Adding DocStrings to the remaining files done in #150 . 🎉

Copy link
Member

@Ayushk4 Ayushk4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some changes to suggest based on the official julia documentation -

  • Function signature should be written with a four spaced indent.
  • The one line docstrings should be imperative form, followed by a blank line and then a 2nd paragraph.
  • The first line should end with a fullstop.
  • Some places arguments have been provided where it may not be necessary (Refer point 4 in docs).

src/corpus.jl Show resolved Hide resolved
src/corpus.jl Outdated Show resolved Hide resolved
src/document.jl Outdated Show resolved Hide resolved
src/document.jl Outdated Show resolved Hide resolved
src/dtm.jl Outdated Show resolved Hide resolved
src/dtm.jl Outdated Show resolved Hide resolved
src/document.jl Outdated Show resolved Hide resolved
src/hash.jl Show resolved Hide resolved
@aquatiko aquatiko changed the title [WIP] Add API documentation Add API documentation May 30, 2019
@aquatiko
Copy link
Contributor Author

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

@aviks
Copy link
Member

aviks commented Jun 9, 2019

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

@aquatiko
Copy link
Contributor Author

Done @aviks

@aviks aviks merged commit 9292c80 into JuliaText:master Jun 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need API documentation
4 participants