Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
G GeoTrees
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3
    • Issues 3
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Package Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • NOCSurfaceProcesses
  • GeoTrees
  • Merge requests
  • !27

Merged
Created 2 months ago by Joseph Siddons@josiddOwner

Resolve "Improve documentation"

  • Overview 2
  • Commits 25
  • Pipelines 3
  • Changes 30
1 unresolved thread

Closes #10 (closed)

Edited 2 months ago by Joseph Siddons
  • Joseph Siddons @josidd changed milestone to %Version 1 2 months ago

    changed milestone to %Version 1

  • Joseph Siddons @josidd added DOCS label 2 months ago

    added DOCS label

  • Joseph Siddons @josidd added 1 commit 2 months ago

    added 1 commit

    • 013d3e72 - docs: remove header from module docstring

    Compare with previous version

  • Joseph Siddons @josidd added 2 commits 2 months ago

    added 2 commits

    • 8302ff2f - docs: add sections for quadtree and record classes
    • b5338b62 - docs: add more octtree documentation

    Compare with previous version

  • Joseph Siddons @josidd marked this merge request as draft 2 months ago

    marked this merge request as draft

  • Joseph Siddons @josidd added 2 commits 2 months ago

    added 2 commits

    • 179abd21 - refactor!: move record and shape objects to separate modules
    • a80ee486 - chore: update changelog

    Compare with previous version

  • Joseph Siddons @josidd added 1 commit 2 months ago

    added 1 commit

    • 165874bd - docs: add docstring for record module

    Compare with previous version

  • Joseph Siddons @josidd added 7 commits 2 months ago

    added 7 commits

    • 81b58c7e - docs: correct class names in docstrings
    • 2133146b - docs: correct imports on readme
    • 58486683 - docs: change syntax highlighting scheme
    • c848f1ab - docs: correct imports and re-run notebook
    • edda0afd - docs: add section title to docstring
    • 5b169c44 - docs: add clarifying comment
    • 2bd97b5c - fix: correct imports

    Compare with previous version

    Toggle commit list
  • Joseph Siddons @josidd added 1 commit 2 months ago

    added 1 commit

    • b1ac976b - docs: improve docstrings for find_nearest

    Compare with previous version

  • Joseph Siddons @josidd added 4 commits 2 months ago

    added 4 commits

    • 4ae12b16 - refactor!: remove SpaceTimeRecords class, use list[SpaceTimeRecord]
    • ff46acb1 - docs: improve QuadTree method docstrings
    • b006a26a - docs: complete documentation
    • 67b9e5d4 - chore: update changelog

    Compare with previous version

    Toggle commit list
    • Joseph Siddons
      Joseph Siddons @josidd · 2 months ago
      Owner

      @ricorne : please have a look at docs/Documentation.pdf and let me know if you have any suggestions.

    • Collapse replies
    • Joseph Siddons
      Joseph Siddons @josidd · 2 months ago
      Owner

      https://git.noc.ac.uk/nocsurfaceprocesses/geospatialtools/-/blob/0bb2e0e603aef49e789188a1c7a8097a22fb8421/docs/Documentation.pdf

      edit: update file to latest commit

      Edited by Joseph Siddons 1 month ago
    • Please register or sign in to reply
  • Joseph Siddons @josidd requested review from @ricorne 2 months ago

    requested review from @ricorne

  • Joseph Siddons @josidd marked this merge request as ready 2 months ago

    marked this merge request as ready

  • Joseph Siddons @josidd added 25 commits 1 month ago

    added 25 commits

    • 67b9e5d4...e606e155 - 23 commits from branch nocsurfaceprocesses:main
    • 8e9bae21 - Merge branch 'main' into 10-improve-documentation
    • 611ebfa6 - Merge "main" into "10-improve-documentation"

    Compare with previous version

  • Joseph Siddons @josidd added 1 commit 1 month ago

    added 1 commit

    • bd0d5c29 - ci: pre-commit fixes

    Compare with previous version

  • Joseph Siddons @josidd added 1 commit 1 month ago

    added 1 commit

    • 0c92925a - docs: add pre-commit instructions to CONTRIBUTING

    Compare with previous version

  • Joseph Siddons @josidd merged 2 days ago

    merged

  • Joseph Siddons @josidd mentioned in commit 786a9658 2 days ago

    mentioned in commit 786a9658

  • You're only seeing other activity in the feed. To add a comment, switch to one of the following options.
Please register or sign in to reply
Compare
  • version 10
    bd0d5c29
    1 month ago

  • version 9
    611ebfa6
    1 month ago

  • version 8
    67b9e5d4
    2 months ago

  • version 7
    b1ac976b
    2 months ago

  • version 6
    2bd97b5c
    2 months ago

  • version 5
    165874bd
    2 months ago

  • version 4
    a80ee486
    2 months ago

  • version 3
    b5338b62
    2 months ago

  • version 2
    013d3e72
    2 months ago

  • version 1
    eb85c872
    2 months ago

  • main (base)

and
  • latest version
    0c92925a
    25 commits, 1 month ago

  • version 10
    bd0d5c29
    24 commits, 1 month ago

  • version 9
    611ebfa6
    23 commits, 1 month ago

  • version 8
    67b9e5d4
    21 commits, 2 months ago

  • version 7
    b1ac976b
    17 commits, 2 months ago

  • version 6
    2bd97b5c
    16 commits, 2 months ago

  • version 5
    165874bd
    9 commits, 2 months ago

  • version 4
    a80ee486
    8 commits, 2 months ago

  • version 3
    b5338b62
    6 commits, 2 months ago

  • version 2
    013d3e72
    4 commits, 2 months ago

  • version 1
    eb85c872
    3 commits, 2 months ago

1 file
+ 12
- 1
Show latest version
    File browser
    Compare changes
GeoSpatialTools/record.py
+ 12
- 1
  • View file @ 165874bd

  • Edit in single-file editor

  • Edit in Web IDE


Files with large changes are collapsed by default.

"""DOCUMENTATION"""
"""
Record objects used for containing data passed to QuadTree, OctTree and KDTree
classes. Require positions defined by "lon" and "lat", SpaceTimeRecord objects
also require "datetime". Optional fields are "uid", other data can be passed as
keyword arguments. Only positional, temporal, and uid values are used for
equality checks.
Distances between records is calculated using Haversine distance.
Classes prefixed by "SpaceTime" include a temporal dimension and should be used
with OctTree classes.
"""
from typing import List, Optional
from datetime import datetime
Show 20 lines Show all unchanged lines
Assignee
Joseph Siddons's avatar
Joseph Siddons
@josidd
Assign to
Reviewer
ricorne's avatar
@ricorne
Request review from
Version 1
Milestone
Version 1
Assign milestone
None
Time tracking
No estimate or time spent
1
Labels
DOCS
Assign labels
  • No matching results
  • Manage project labels
Lock merge request
Unlocked
2
2 participants
user avatar
user avatar
Reference:
Source branch: 10-improve-documentation

    0 pending comments