Skip to content

various fixes to docs and docstrings#21

Merged
lostella merged 5 commits intoJuliaFirstOrder:masterfrom
lostella:fix-docs
Jul 12, 2019
Merged

various fixes to docs and docstrings#21
lostella merged 5 commits intoJuliaFirstOrder:masterfrom
lostella:fix-docs

Conversation

@lostella
Copy link
Copy Markdown
Member

Addresses #20 among other things

@lostella lostella requested a review from nantonel July 10, 2019 14:26
@lostella lostella mentioned this pull request Jul 10, 2019
@codecov-io
Copy link
Copy Markdown

codecov-io commented Jul 10, 2019

Codecov Report

Merging #21 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #21   +/-   ##
=======================================
  Coverage   91.52%   91.52%           
=======================================
  Files          17       17           
  Lines         413      413           
=======================================
  Hits          378      378           
  Misses         35       35
Impacted Files Coverage Δ
src/syntax/variable.jl 90% <ø> (ø) ⬆️
src/syntax/problem.jl 100% <ø> (ø) ⬆️
src/solvers/build_solve.jl 95% <ø> (ø) ⬆️
src/syntax/expressions/abstractOperator_bind.jl 100% <ø> (ø) ⬆️
src/syntax/expressions/utils.jl 77.77% <ø> (ø) ⬆️
src/syntax/expressions/addition.jl 80.82% <ø> (ø) ⬆️
src/StructuredOptimization.jl 100% <ø> (ø) ⬆️
src/solvers/minimize.jl 93.75% <ø> (ø) ⬆️
src/syntax/expressions/multiplication.jl 100% <100%> (ø) ⬆️
src/syntax/terms/proximalOperators_bind.jl 91.22% <100%> (ø) ⬆️

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 4dde469...dcf9940. Read the comment docs.

Copy link
Copy Markdown
Collaborator

@nantonel nantonel left a comment

Choose a reason for hiding this comment

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

By the way we could add a CITATION.bib: the other day I was reading this (publication section) and found out that they also standardised this.

Comment thread docs/src/solvers.md
Comment thread src/solvers/minimize.jl Outdated
Comment thread src/solvers/minimize.jl
@nantonel
Copy link
Copy Markdown
Collaborator

By the way we could add a CITATION.bib: the other day I was reading this (publication section) and found out that they also standardised this.

Perhaps we should wait for the paper to be accepted 😄

@nantonel
Copy link
Copy Markdown
Collaborator

nantonel commented Jul 11, 2019

Ok now ForwardBackward, PANOC and ZeroFPR are exported and their docs added.

Comment thread docs/make.jl

makedocs(
modules = [StructuredOptimization],
modules = [StructuredOptimization,ProximalAlgorithms],
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

That's the trick!

@lostella lostella merged commit 7cf78b8 into JuliaFirstOrder:master Jul 12, 2019
@lostella lostella deleted the fix-docs branch July 12, 2019 00:26
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.

3 participants