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

Fix failing params doctests #1798

Merged
merged 1 commit into from
Dec 10, 2021
Merged

Fix failing params doctests #1798

merged 1 commit into from
Dec 10, 2021

Conversation

ToucheSir
Copy link
Member 

julia> [[1, 2, 3], [4.0]]
2-element Vector{Vector{Float64}}:
 [1.0, 2.0, 3.0]
 [4.0]

julia> [[1, 2, 3], [4]]
2-element Vector{Vector{Int64}}:
 [1, 2, 3]
 [4]

PR Checklist

  • Tests are added
  • Documentation, if applicable

@ToucheSir
Fix failing params doctests
a37aa08 
```julia
julia> [[1, 2, 3], [4.0]]
2-element Vector{Vector{Float64}}:
 [1.0, 2.0, 3.0]
 [4.0]

julia> [[1, 2, 3], [4]]
2-element Vector{Vector{Int64}}:
 [1, 2, 3]
 [4]
```
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2021

Once the build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Flux.jl/previews/PR1798/ in ~20 minutes

@DhairyaLGandhi
Copy link
Member

Best to keep changes minimal if possible.

@ToucheSir
Copy link
Member Author

I got a notification for a comment that doesn't appear for me on GH, but just to respond to the thread: I changed both to keep the intent of the original in showing params(a, b) == params([a, b]). params([1.0, 2.0, 3.0], [4.0]) and params([[1.0, 2.0, 3.0], [4.0]]) would've worked as well but been noisier to read.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2021

Once the build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Flux.jl/previews/PR1798/ in ~20 minutes

DhairyaLGandhi
DhairyaLGandhi reviewed Dec 10, 2021
View reviewed changes
Copy link
Member

@DhairyaLGandhi DhairyaLGandhi left a comment

Choose a reason for hiding this comment

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

bors r+

bors bot added a commit that referenced this pull request Dec 10, 2021
@bors @ToucheSir
Merge #1798
67defb8 
1798: Fix failing `params` doctests r=DhairyaLGandhi a=ToucheSir

```julia
julia> [[1, 2, 3], [4.0]]
2-element Vector{Vector{Float64}}:
 [1.0, 2.0, 3.0]
 [4.0]

julia> [[1, 2, 3], [4]]
2-element Vector{Vector{Int64}}:
 [1, 2, 3]
 [4]
```

### PR Checklist

- [x] Tests are added
- [x] Documentation, if applicable


Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
@bors
Copy link
Contributor

bors bot commented Dec 10, 2021

This PR was included in a batch that successfully built, but then failed to merge into master. It will not be retried.

Additional information:

{"message":"At least 1 approving review is required by reviewers with write access.","documentation_url":"https://docs.github.com/articles/about-protected-branches"}

DhairyaLGandhi
DhairyaLGandhi approved these changes Dec 10, 2021
View reviewed changes
Copy link
Member

@DhairyaLGandhi DhairyaLGandhi left a comment

Choose a reason for hiding this comment

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

bors r+

@bors
Copy link
Contributor

bors bot commented Dec 10, 2021

Build succeeded:

@bors bors bot merged commit 0a4d4dd into master Dec 10, 2021
@ToucheSir ToucheSir deleted the bc/params-doctest-fix branch December 10, 2021 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DhairyaLGandhi DhairyaLGandhi DhairyaLGandhi approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@ToucheSir @DhairyaLGandhi @logankilpatrick