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.

Sign up for GitHub

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

Jump to bottom

transition some docs to doctests #1436

Merged
merged 1 commit into from
Dec 24, 2020
Merged

transition some docs to doctests #1436

merged 1 commit into from
Dec 24, 2020

Conversation

gxyd
Copy link
Contributor

@gxyd gxyd commented Dec 22, 2020

Fixes #1403

gxyd
gxyd commented Dec 22, 2020
View reviewed changes
src/layers/basic.jl Outdated
@@ -9,7 +9,7 @@ on a given input.

# Examples
```jldoctest
julia> m = Chain(x -> x^2, x -> x+1);
julia> m = Chain(x -> x^2, x -> x);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will undo this, I made this change intentionally to see whether CI fails or not.

@gxyd gxyd changed the title fix jldoctest of outdims transition some docs to doctests Dec 22, 2020
@gxyd
Copy link
Contributor Author

gxyd commented Dec 22, 2020

Partially goes in the direction of #561 . This is ready now.

@DhairyaLGandhi
Copy link
Member

Lgtm, thanks a lot!

bors r+

bors bot added a commit that referenced this pull request Dec 22, 2020
@bors @gxyd
Merge #1436
bc6128f 
1436: transition some docs to doctests r=DhairyaLGandhi a=gxyd

Fixes #1403 

Co-authored-by: Gaurav Dhingra <gauravdhingra.gxyd@gmail.com>
@gxyd
Copy link
Contributor Author

gxyd commented Dec 22, 2020

Thanks @DhairyaLGandhi . Btw, you'll still need to approve 😉 .

@CarloLucibello
Copy link
Member

bors r+

@bors
Copy link
Contributor

bors bot commented Dec 24, 2020

Build succeeded:

@bors bors bot merged commit 2039f3f into FluxML:master Dec 24, 2020
@gxyd gxyd deleted the fix_doc branch December 28, 2020 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CarloLucibello CarloLucibello CarloLucibello approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Non-reproducible example in documentation
3 participants
@gxyd @DhairyaLGandhi @CarloLucibello