Skip to content

Improvements in the documentation of introprog.IO. #14 #15

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

Merged
merged 1 commit into from
Dec 19, 2020
Merged

Improvements in the documentation of introprog.IO. #14 #15

merged 1 commit into from
Dec 19, 2020

Conversation

wudse20
Copy link
Contributor

@wudse20 wudse20 commented Dec 18, 2020

  • Added @param for each method to explain the parameters
    in better detail.
  • Added @return for each method, not the ones returning unit,
    to better explain the returnvalue of the methods.

 - Added @param for each method to explain the parameters
   in better detail.
 - Added @return for each method, not the ones returning unit,
   to better explain the returnvalue of the methods.
@wudse20
Copy link
Contributor Author

wudse20 commented Dec 18, 2020

I think this's better than it was before. I'd love some feedback on the pr.

@bjornregnell
Copy link
Member

Thanks for working on this! Indeed more useful docs.

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.

2 participants