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

Update the documentation on Projections #124

Open
yeesian opened this issue Jun 3, 2020 · 9 comments
Open

Update the documentation on Projections #124

yeesian opened this issue Jun 3, 2020 · 9 comments

Comments

@yeesian
Copy link
Owner

yeesian commented Jun 3, 2020

We should update https://github.com/yeesian/ArchGDAL.jl/blob/master/docs/src/projections.md with the recent updates with GeoFormat and #120.

@visr
Copy link
Collaborator

visr commented Aug 12, 2020

Docs haven't been building since mentioned PR, because we have strict = true, so these warnings were turned into errors:

┌ Error: 4 docstrings potentially missing:
│
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:GeoFormatTypes.GeoFormat,Union{Type{GeoFormatTypes.FormatMode}, GeoFormatTypes.FormatMode},GeoFormatTypes.GeoFormat}
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:ArchGDAL.AbstractGeometry,GeoFormatTypes.AbstractWellKnownText}
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:GeoFormatTypes.AbstractWellKnownText,ArchGDAL.AbstractGeometry}
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:GeoFormatTypes.GeoFormat,Union{GeoFormatTypes.CRS,Type{GeoFormatTypes.CRS}},GeoFormatTypes.GeoFormat}
└ @ Documenter.DocChecks C:\Users\visser_mn\.julia\packages\Documenter\bRylW\src\DocChecks.jl:66

I'm not sure how to fix them. The docstrings that were actually there in convert.jl caused these errors (not their absence). I had to choose between setting strict = false and allowing issues to creep in, or keep it strict, and disable the docstrings by putting a newline between them and the function definitions. I went for the latter for now. So @rafaqz if you wonder where your Base.convert docstrings went, they are still in the file, but not as docstrings.

Actually we probably should update our setup such that CI is red if the docs don't build, to prevent getting stuck with old builds.

@visr
Copy link
Collaborator

visr commented Aug 12, 2020

@yeesian in the new Documenter.jl a canonical url should be given, which I believe also helps SEO; which do you prefer:

  • canonical = "https://yeesian.com/ArchGDAL.jl"
  • canonical = "https://yeesian.github.io/ArchGDAL.jl"
    I assume yeesian.com since that is what it jumps to right now, but just making sure.

visr added a commit that referenced this issue Aug 12, 2020
also upgrades to Documenter 0.25

See also #124
@yeesian
Copy link
Owner Author

yeesian commented Aug 13, 2020

Hey Martjin! Regarding the canonical url, I personally don't have a preference -- this package is becoming pretty community-driven, so we might prefer for it be based on github's domain, so that the switch to JuliaGeo (if we might prefer it) might not come across so jarringly to users browsing the documentation? I'll be happy either way -- let me know what you think.

@visr
Copy link
Collaborator

visr commented Aug 13, 2020

I think either way is fine. If we do yeesian.com and do move the package over to JuliaGeo later, we should put in automatic forwarding similar to how it would be done on the GitHub url, such that old links will still work. As long as that can be done, it should give no issues at all. Though perhaps even that will be automatic, since the site is still hosted on GitHub servers, which will forward as well.

@yeesian
Copy link
Owner Author

yeesian commented Aug 14, 2020

Okay yeah that works for me -- let's go with yeesian.com in that case to preserve the current behavior then, thanks for thinking it through!

yeesian pushed a commit that referenced this issue Aug 15, 2020
* Implementation of DiskArray interface

* For simplicity, wrap the block iterator into a GridChunks for now

* Remove broken tests

* Update to most recent DiskArray interface

* add DiskArray compat

* Fix for read and write

* Fix signature

* Add more doc strings and remove unnecessary comments

* Minor additions

* Fix typos and extend forwarded methods

* Add tests for RasterDataset forwarded methods

* More tests for the DiskArray interface

* Add section to raster docs

* Update docs/src/rasters.md

Co-authored-by: Felix Cremer <felix.cremer@uni-jena.de>

* Update docs/src/rasters.md

Co-authored-by: Felix Cremer <felix.cremer@uni-jena.de>

* sort Project.toml

* make filelist test OS proof

* require DiskArrays 0.2.4 for 32 bit

* Add tests for Window iterator

(cherry picked from commit 9f731d5)

* code style updates

* overload Base.Array

* make the docs build again

also upgrades to Documenter 0.25

See also #124

* Update docs/src/rasters.md

Co-authored-by: Felix Cremer <felix.cremer@uni-jena.de>

* Add show method

* Add MIME type to rasterband show

This avoids the usage of the DiskArray show method for rasterbands
We need the version without MIME type so that we can use the print
function.

Co-authored-by: Felix Cremer <felix.cremer@uni-jena.de>
Co-authored-by: Martijn Visser <mgvisser@gmail.com>
@yeesian
Copy link
Owner Author

yeesian commented Apr 26, 2021

The docs are building now, so I'm closing this issue.

@yeesian yeesian closed this as completed Apr 26, 2021
@visr
Copy link
Collaborator

visr commented Apr 26, 2021

This issue got sidetracked on whether the docs build at all, but the issue in the top post is not yet addressed, right?

@yeesian yeesian reopened this Apr 26, 2021
@yeesian
Copy link
Owner Author

yeesian commented Apr 26, 2021

Oh sorry I missed it, thanks for the catch! Re-opening until we address the comments in #124 (comment).

@rafaqz
Copy link
Collaborator

rafaqz commented Apr 26, 2021

Sorry I missed this thread before, I probably should have added manual doces with that PR. See when I have time to do it.

@yeesian yeesian added this to the v1.0 milestone May 15, 2021
mathieu17g added a commit to mathieu17g/ArchGDAL.jl that referenced this issue Oct 3, 2021
mathieu17g added a commit to mathieu17g/ArchGDAL.jl that referenced this issue Oct 8, 2021
mathieu17g added a commit to mathieu17g/ArchGDAL.jl that referenced this issue Oct 9, 2021
yeesian pushed a commit that referenced this issue Oct 11, 2021
…xit (done in `__init__()`). Plus a few modifications on GDAL utilities' tests and (#245)

* For GDAL utilities tests, separate error tests from normal tests

* Added GDAL import in test_images.jl

* Suppressed `@time` macro in test_ospy_examples.jl

* Add `@test_logs` to two tests issuing a warning in test_rasterattrtable.jl

* CPLDestroyMutex Error narrowed on one test in test_gdalutilities_errors.jl

* `GDAL.gdalinfo` in a try...finally block

* fixed a typo in file name in "GDAL error" testset

* changed `options` local variable name in `AG.gdalinfo` in case it may interfere with `options` arg

* Tried to test errored  `AG.galinfo`  with `@test` instead of `@test_throws`

* cleanup after (unsuccessful) investigation on "CPLDestroyMutex: Error = 16" issue

* DriverManager modifications proposition

* deregister gdaljl_errorhandler at exit

* deregisterering gdaljl_errorhandler via an anonymous function to avoid test coverage decrease

* Cleanup keeping gdaljl_errorhandler deregistration at exit in __init()__

* Suppressed `GDAL.cplseterrorhandler` (handled in GDAL.jl `__init__()`) and added `GDAL.gdaldestroydrivermanager` in `atexit`

* Cleanup in `__init__()` with GDAL.jl PR #124 as prerequisite

* Suppressed comments in ArchGDAL.jl `__init__()`  function

* Dropped `gdalallregister()` in `__init__()` since it has been added to GDAL.jl in PR JuliaGeo/GDAL.jl#124
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants