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

Updating @JLayer Docstring #383

Merged
merged 1 commit into from
Jan 1, 2022
Merged

Updating @JLayer Docstring #383

merged 1 commit into from
Jan 1, 2022

Conversation

TheCedarPrince
Copy link
Member

PR Checklist

If you are contributing to Javis.jl, please make sure you are able to check off each item on this list:

  • Did I update CHANGELOG.md with whatever changes/features I added with this PR?
  • Did I make sure to only change the part of the file where I introduced a new change/feature?
  • Did I cover all corner cases to be close to 100% test coverage (if applicable)?
  • Did I properly add Javis dependencies to the Project.toml + set an upper bound of the dependency (if applicable)?
  • Did I properly add test dependencies to the test directory (if applicable)?
  • Did I check relevant tutorials that may be affected by changes in this PR?
  • Did I clearly articulate why this PR was made the way it was and how it was made?

Link to relevant issue(s)
Closes #382

How did you address these issues with this PR? What methods did you use?

This fixes some issues with the JLayers docstring. I started by fixing the example that is within the docstring itself. @Sov-trotter - feel free to add the rest of your changes here to address issue #382

@TheCedarPrince TheCedarPrince added documentation Improvements or additions to documentation easy review PR which is easy to review labels Aug 5, 2021
@codecov
Copy link

codecov bot commented Aug 5, 2021

Codecov Report

Merging #383 (034cd79) into master (41f84e7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #383   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files          27       27           
  Lines        1369     1369           
=======================================
  Hits         1314     1314           
  Misses         55       55           
Impacted Files Coverage Δ
src/layers.jl 84.37% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41f84e7...034cd79. Read the comment docs.

@Wikunia
Copy link
Member

Wikunia commented Sep 7, 2021

We might just wanna merge this as this fixes one part of the docstring and just keep #382 open though to fix the others

@Wikunia Wikunia marked this pull request as ready for review December 31, 2021 20:05
@Wikunia
Copy link
Member

Wikunia commented Dec 31, 2021

@TheCedarPrince can we merge this?

@TheCedarPrince
Copy link
Member Author

Yes, I think there was more I wanted to do here, but I can open other issues to review docs later.
Merging now.

@TheCedarPrince TheCedarPrince merged commit 64b4218 into master Jan 1, 2022
@TheCedarPrince TheCedarPrince deleted the tcp-layers-docstring branch January 1, 2022 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation easy review PR which is easy to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JLayers docstring needs update
2 participants