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 docs for the annotation download file format #6546

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Fix docs for the annotation download file format #6546

merged 1 commit into from
Oct 12, 2022

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Oct 12, 2022

@fm3 fm3 requested a review from jstriebel October 12, 2022 07:26
@fm3 fm3 self-assigned this Oct 12, 2022
jstriebel
jstriebel approved these changes Oct 12, 2022
View reviewed changes
Copy link
Contributor

@jstriebel jstriebel left a comment

Choose a reason for hiding this comment

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

LGTM 👍

docs/rest_api.md
Comment on lines +355 to +356
#### Note
- The volume data zip file name used to always be `data.zip`, when wk supported only a single volume layer per annotation. Please use the file names referenced in the `<volume>` tags in the NML file instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

You could also use an admonition from mkdocs here, see
https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage

(They are already configured in the docs, so just adding the syntax would be enough.)

Feel free to leave as-is as well.

@fm3 fm3 merged commit faa9f1f into master Oct 12, 2022
@fm3 fm3 deleted the download-docs branch October 12, 2022 07:45
hotzenklotz added a commit that referenced this pull request Oct 13, 2022
@hotzenklotz
Merge branch 'master' of github.com:scalableminds/webknossos into pro…
8810958 
…jects-created

* 'master' of github.com:scalableminds/webknossos: (337 commits)
  Fix docs for the annotation download file format (#6546)
  Added total runtime information to VX reports (#6543)
  fix VX report for completed + skipped tasks (#6540)
  Avoid allocating spire uint objects during apply agglomerate (#6532)
  Explore remote N5 datasets (#6520)
  Fix MeshChunk byteOffset (Long, not Int) (#6536)
  update browserslist (#6505)
  Support new Mesh File (v3) (#6491)
  makes workflow_yamlContent optional (#6518)
  Always return 404 for Failures in Zarr Streaming (#6515)
  Poll wk version to notify during upgrade (#6451)
  add script which extracts newest changelog and creates GH release for it (#6504)
  release 22.10.0 (#6500)
  voxel³ -> voxel (#6501)
  Allow task type summary to identify task type when creating tasks in bulk (#6486)
  Fix sql evolution 090 (defer not null constraint) (#6498)
  SQL schema cleanup (#6492)
  Fix validation of layer selection when trying to start globalization of floodfills (#6497)
  Add "shift + w" shortcut to cycle backwards through tools (#6493)
  Fix filtering for public datasets in dataset table (#6496)
  ...
hotzenklotz added a commit that referenced this pull request Oct 14, 2022
@hotzenklotz
Merge branch 'master' of github.com:scalableminds/webknossos into ass…
acffbca 
…ign_task

* 'master' of github.com:scalableminds/webknossos:
  Added more filters and sorting options to Projects list (#6550)
  fix double occurance of "ago" in VX progress times (#6535)
  Fix docs for the annotation download file format (#6546)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jstriebel jstriebel jstriebel approved these changes

Assignees

@fm3 fm3

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fm3 @jstriebel