search

JuliaSmoothOptimizers / BundleAdjustmentModels.jl

Julia repository of bundle adjustment problems
Mozilla Public License 2.0
9 stars 5 forks source link

use strict=true in docs #70

Closed dpo closed 1 year ago

codecov[bot] commented 2 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@8994c82). Click here to learn what that means. Patch coverage: 100.00% of modified lines in pull request are covered.

:exclamation: Current head f5e14fa differs from pull request most recent head 5e6088d. Consider uploading reports for the commit 5e6088d to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #70 +/- ## ======================================= Coverage ? 92.54% ======================================= Files ? 5 Lines ? 295 Branches ? 0 ======================================= Hits ? 273 Misses ? 22 Partials ? 0 ``` | [Impacted Files](https://codecov.io/gh/JuliaSmoothOptimizers/BundleAdjustmentModels.jl/pull/70?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers) | Coverage Δ | | |---|---|---| | [src/BundleAdjustmentNLSFunctions.jl](https://codecov.io/gh/JuliaSmoothOptimizers/BundleAdjustmentModels.jl/pull/70?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0J1bmRsZUFkanVzdG1lbnROTFNGdW5jdGlvbnMuamw=) | `97.19% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

dpo commented 2 years ago

@AntoninKns Please add missing docstrings.

AntoninKns commented 2 years ago

Do you mean for every function or only exported functions ?

dpo commented 2 years ago

Look at the failing documentation build. All the functions mentioned in there don't have a docstring.

AntoninKns commented 2 years ago

I don't understand what the problem is. What the stack trace is telling is that there are 10 functions for which there is a doctrsing that is not referenced in the documentation. All of these functions are not exported and they are not supposed to be called by the users of this module. I can add them in the documentation but I think it would only be more confusing, no ?

tmigot commented 2 years ago

I don't understand what the problem is. What the stack trace is telling is that there are 10 functions for which there is a doctrsing that is not referenced in the documentation. All of these functions are not exported and they are not supposed to be called by the users of this module. I can add them in the documentation but I think it would only be more confusing, no ?

The doc can also be useful for developers/maintainers of the package :). For non-exported functions, it can be more concised.

dpo commented 2 years ago

@AntoninKns any news here?