Code

api: create docs#908

Code

Merged

jorgeorpinel merged 109 commits intomasteriterative/dvc.org:masterfrom apiiterative/dvc.org:apiCopy head branch name to clipboardMar 8, 2020

+485-27

Commits

Commits on Jan 8, 2020

• api: create index and structure

  Show description for d56f2d2
  jorgeorpinel

  committed
  d56f2d2

  Copy full SHA for d56f2d2

• api ref: add summon page, improve format of all pages

  jorgeorpinel

  committed
  d53833f

  Copy full SHA for d53833f

• api ref: complete pages per initial desc.

  Show description for aba4954
  jorgeorpinel

  committed
  aba4954

  Copy full SHA for aba4954

Commits on Jan 9, 2020

• api: better formatting, added links, and examples

  Show description for 0f5a3bb
  jorgeorpinel

  committed
  0f5a3bb

  Copy full SHA for 0f5a3bb

• api ref: reorder pages, refine descriptions and options, add examples

  jorgeorpinel

  committed
  701aeb7

  Copy full SHA for 701aeb7

• api: note that env mgr install is required

  Show description for 6a18d61
  jorgeorpinel

  committed
  6a18d61

  Copy full SHA for 6a18d61

• api ref: typo in index

  jorgeorpinel

  committed
  a3023be

  Copy full SHA for a3023be

• cmd ref: improve path description in get and import

  jorgeorpinel

  committed
  09c76c5

  Copy full SHA for 09c76c5

• api: improve path/name and repo param descriptions

  jorgeorpinel

  committed
  8c14cbd

  Copy full SHA for 8c14cbd

• api: improve repo param desc

  jorgeorpinel

  committed
  97c3972

  Copy full SHA for 97c3972

• api: add assumed defaults to all params in all functions

  jorgeorpinel

  committed
  6894e77

  Copy full SHA for 6894e77

• api: oops, forgot about repo param's default :B

  jorgeorpinel

  committed
  711838d

  Copy full SHA for 711838d

• api: comlpete get_url desc and real life example

  Show description for 68a3dd0
  jorgeorpinel

  committed
  68a3dd0

  Copy full SHA for 68a3dd0

Commits on Jan 10, 2020

• use-cases: link from data-registries to api ref

  jorgeorpinel

  committed
  95fa070

  Copy full SHA for 95fa070

• doc: add some basic links between API and cmd refs

  jorgeorpinel

  committed
  09db290

  Copy full SHA for 09db290

Commits on Jan 11, 2020

• api: better desc. and example explanation in get_url

  jorgeorpinel

  committed
  bb05e9c

  Copy full SHA for bb05e9c

• api: improve index desc (again?)

  jorgeorpinel

  committed
  58e4bb5

  Copy full SHA for 58e4bb5

Commits on Jan 12, 2020

• api: update get_url example to use iterative/dataset-registry repo

  jorgeorpinel

  committed
  08fe226

  Copy full SHA for 08fe226

• api: complete base examples for get_url, open, and read (they may need confirmation)

  jorgeorpinel

  committed
  c207152

  Copy full SHA for c207152

Commits on Jan 14, 2020

• install: add notes about installing as a Python lib

  Show description for 4a50af9
  jorgeorpinel

  committed
  4a50af9

  Copy full SHA for 4a50af9

Commits on Jan 15, 2020

• api ref: add note about file existence in get_url, and related updates

  Show description for 89734fd
  jorgeorpinel

  committed
  89734fd

  Copy full SHA for 89734fd

Commits on Jan 16, 2020

• api: copy edits

  Show description for c094233
  jorgeorpinel

  committed
  c094233

  Copy full SHA for c094233

• api: add notes about possible errors in function arguments

  jorgeorpinel

  committed
  8b133ca

  Copy full SHA for 8b133ca

• api: add return types to first 3 functions

  jorgeorpinel

  committed
  eec0848

  Copy full SHA for eec0848

• api: add list of remotes you can strem from for open fn

  Show description for 9b58c3f
  jorgeorpinel

  committed
  9b58c3f

  Copy full SHA for 9b58c3f

• Merge branch 'master' into api

  jorgeorpinel

  committed
  af3ee37

  Copy full SHA for af3ee37

Commits on Jan 19, 2020

• Merge branch 'master' into api

  jorgeorpinel

  committed
  eeb318c

  Copy full SHA for eeb318c

• api ref: remove summon() page

  Show description for 3e0b909
  jorgeorpinel

  committed
  3e0b909

  Copy full SHA for 3e0b909

Commits on Jan 21, 2020

• api ref: add full modue path to exceptions mentioned so far

  Show description for 9cf939f
  jorgeorpinel

  committed
  9cf939f

  Copy full SHA for 9cf939f

• api: fix term "environment manager"

  Show description for 59bb2f2
  jorgeorpinel

  committed
  59bb2f2

  Copy full SHA for 59bb2f2

• api ref: separate short and long desc, similar to cmd ref

  Show description for e340321
  jorgeorpinel

  committed
  e340321

  Copy full SHA for e340321

• api ref: small language refinements

  jorgeorpinel

  committed
  cc4a7a8

  Copy full SHA for cc4a7a8

Commits on Jan 23, 2020

• api ref: add note about .dir cache files in get_url

  Show description for 24f2d67
  jorgeorpinel

  committed
  24f2d67

  Copy full SHA for 24f2d67

Commits on Feb 7, 2020

• Merge branch 'master' into api

  jorgeorpinel

  committed
  e26ef15

  Copy full SHA for e26ef15

• api: correct exception path in get_url

  Show description for 026eaa2
  jorgeorpinel

  committed
  026eaa2

  Copy full SHA for 026eaa2

Commits on Feb 8, 2020

• api: standard indentation and arg usage in all examples, and

  Show description for 3815a09
  jorgeorpinel

  committed
  3815a09

  Copy full SHA for 3815a09

• api: improve last open() example

  Show description for 382b195
  jorgeorpinel

  committed
  382b195

  Copy full SHA for 382b195

• api: std use of single vs double quotes and add mode='rb' in read() example

  Show description for 013f5df
  jorgeorpinel

  committed
  013f5df

  Copy full SHA for 013f5df

• api: update index and install section

  Show description for e9340ce
  jorgeorpinel

  committed
  e9340ce

  Copy full SHA for e9340ce

• cmd ref: refactor and simplify notes to emphasize those linking to api ref

  Show description for 0a725e8
  jorgeorpinel

  committed
  0a725e8

  Copy full SHA for 0a725e8

• api ref: rewrite get_url intro

  Show description for d696063
  jorgeorpinel

  committed
  d696063

  Copy full SHA for d696063

• api ref: simplify note about get_url not checking for file/dir existence

  Show description for f13b311
  jorgeorpinel

  committed
  f13b311

  Copy full SHA for f13b311

Commits on Feb 9, 2020

• api ref: update note about directory JSON .dir files in get_url

  Show description for 73adff5
  jorgeorpinel

  committed
  73adff5

  Copy full SHA for 73adff5

• api ref: std. param lang style

  Show description for 6ebe371
  jorgeorpinel

  committed
  6ebe371

  Copy full SHA for 6ebe371

• api ref: simplify and improve basic param descs

  Show description for a921b40
  jorgeorpinel

  committed
  a921b40

  Copy full SHA for a921b40

• api ref: improvements to repo param and get_url example

  Show description for a6f9eec
  jorgeorpinel

  committed
  a6f9eec

  Copy full SHA for a6f9eec

Commits on Feb 12, 2020

• api ref: further explain URL construction in get_url example

  Show description for c1eb598
  jorgeorpinel

  committed
  c1eb598

  Copy full SHA for c1eb598

• api ref: simplify api index

  Show description for 4f42b88
  jorgeorpinel

  committed
  4f42b88

  Copy full SHA for 4f42b88

Commits on Feb 15, 2020

• Merge branch 'master' into api

  jorgeorpinel

  committed
  ffc0117

  Copy full SHA for ffc0117

Commits on Feb 17, 2020

• api: add link to dvcx repo

  jorgeorpinel

  committed
  8208fd9

  Copy full SHA for 8208fd9

• Merge branch 'master' into api

  jorgeorpinel

  committed
  910d319

  Copy full SHA for 910d319

• api: open() and read() support Git-tracked files

  Show description for 1d5d3a9
  jorgeorpinel

  committed
  1d5d3a9

  Copy full SHA for 1d5d3a9

• links: fix link-check for api docs

  jorgeorpinel

  committed
  a11465e

  Copy full SHA for a11465e

• api: typo

  jorgeorpinel

  committed
  f86afde

  Copy full SHA for f86afde

Commits on Feb 18, 2020

• api: Signature -> definition section in all fns

  Show description for 979d70c
  jorgeorpinel

  committed
  979d70c

  Copy full SHA for 979d70c

• api: copy edits and term artifact -> file or dir in get_url

  Show description for 099dc4e
  jorgeorpinel

  committed
  099dc4e

  Copy full SHA for 099dc4e

• api: term artifact -> data since open() and read() don't support dirs

  Show description for 9e21825
  jorgeorpinel

  committed
  9e21825

  Copy full SHA for 9e21825

• api: typo

  jorgeorpinel

  committed
  4eb85b3

  Copy full SHA for 4eb85b3

• api: improvements to fn params

  Show description for b6cd85e
  jorgeorpinel

  committed
  b6cd85e

  Copy full SHA for b6cd85e

• api: updates to repo param

  Show description for 11fb55e
  jorgeorpinel

  committed
  11fb55e

  Copy full SHA for 11fb55e

Commits on Feb 19, 2020

• install: reword link to api ref

  Show description for be2316f
  jorgeorpinel

  committed
  be2316f

  Copy full SHA for be2316f

• term: GitHub URLs -> hosted on GitHub

  Show description for c94610d
  jorgeorpinel

  committed
  c94610d

  Copy full SHA for c94610d

• api: add link to read() from open() desc.

  Show description for 9c52cd8
  jorgeorpinel

  committed
  9c52cd8

  Copy full SHA for 9c52cd8

Commits on Feb 25, 2020

• Merge branch 'master' into api

  jorgeorpinel

  committed
  4219494

  Copy full SHA for 4219494

• api: remove word "directly" fom exception lists

  Show description for 942d81d
  jorgeorpinel

  committed
  942d81d

  Copy full SHA for 942d81d

• api: add basic usage sections

  Show description for e76bd5f
  jorgeorpinel

  committed
  e76bd5f

  Copy full SHA for e76bd5f

• api: improve model open() example

  Show description for 2b8b4a7
  

  jorgeorpinel

  and

  Suor

  authored
  2b8b4a7

  Copy full SHA for 2b8b4a7

• api: fix typos and remove lines between import stmts

  Show description for aa88cea
  jorgeorpinel

  committed
  aa88cea

  Copy full SHA for aa88cea

• Merge branch 'api' of github.com:iterative/dvc.org into api

  jorgeorpinel

  committed
  dc93bb8

  Copy full SHA for dc93bb8

• api: fix closing parentheses in example

  Show description for f66826c
  jorgeorpinel

  committed
  f66826c

  Copy full SHA for f66826c

• api: remove link to dvcx

  Show description for 8b3929c
  jorgeorpinel

  committed
  8b3929c

  Copy full SHA for 8b3929c

• api: updates to open()

  Show description for 3ec79a0
  jorgeorpinel

  committed
  3ec79a0

  Copy full SHA for 3ec79a0

Commits on Feb 27, 2020

• api: improve open() examples

  Show description for fcdf0c4
  jorgeorpinel

  committed
  fcdf0c4

  Copy full SHA for fcdf0c4

• api: improve list of 3rd party lib examples in get_url

  Show description for e5b52ae
  jorgeorpinel

  committed
  e5b52ae

  Copy full SHA for e5b52ae

• api ref: compact intro/signature before loner descs

  Show description for 7f2981f
  jorgeorpinel

  committed
  7f2981f

  Copy full SHA for 7f2981f

• api ref: improve dvc.api.open() desc similar to open() builtin

  Show description for 03d4e72
  jorgeorpinel

  committed
  03d4e72

  Copy full SHA for 03d4e72

• api ref: updates to get_url

  Show description for 6ccfc80
  jorgeorpinel

  committed
  6ccfc80

  Copy full SHA for 6ccfc80

• api ref: impros to open()

  Show description for 418651d
  jorgeorpinel

  committed
  418651d

  Copy full SHA for 418651d

• api ref: more impros to open()

  Show description for 7161e8c
  jorgeorpinel

  committed
  7161e8c

  Copy full SHA for 7161e8c

• api ref: remove term "source" from params

  Show description for a229803
  jorgeorpinel

  committed
  a229803

  Copy full SHA for a229803

• api ref: better wording in path option

  Show description for c43e704
  jorgeorpinel

  committed
  c43e704

  Copy full SHA for c43e704

• api ref: explain mode and encoding options (open/read())

  Show description for 5acaffd
  jorgeorpinel

  committed
  5acaffd

  Copy full SHA for 5acaffd

• api ref: typo project->cache

  jorgeorpinel

  committed
  8840338

  Copy full SHA for 8840338

• api ref: move default param behavior to fn descriptions

  Show description for 2e9dc3d
  jorgeorpinel

  committed
  2e9dc3d

  Copy full SHA for 2e9dc3d

• api ref: add read() snippet in open() example

  Show description for 35674e3
  jorgeorpinel

  committed
  35674e3

  Copy full SHA for 35674e3

Commits on Feb 28, 2020

• api ref: add read() example explanation and fix link check

  Show description for 42e8563
  jorgeorpinel

  committed
  42e8563

  Copy full SHA for 42e8563

• api ref: name examples

  Show description for ed80616
  jorgeorpinel

  committed
  ed80616

  Copy full SHA for ed80616

Commits on Feb 29, 2020

• api ref: move the default arguments/behavior back to params

  Show description for c47b366
  jorgeorpinel

  committed
  c47b366

  Copy full SHA for c47b366

• api ref: use simple language in example titles

  Show description for a1a6b34
  jorgeorpinel

  committed
  a1a6b34

  Copy full SHA for a1a6b34

• api ref: merge local open() example into --rev example

  Show description for a251259
  jorgeorpinel

  committed
  a251259

  Copy full SHA for a251259

• api ref: change motivation of remote arg example in open()

  Show description for af551be
  jorgeorpinel

  committed
  af551be

  Copy full SHA for af551be

• api ref: unserialize -> deserialize

  Show description for 7277e11
  jorgeorpinel

  committed
  7277e11

  Copy full SHA for 7277e11

• api ref: some last refinements 9on this feedback round)

  jorgeorpinel

  committed
  4f04a62

  Copy full SHA for 4f04a62

• api ref: rewrite intro blocks for simplicity, use type hints

  jorgeorpinel

  committed
  925f520

  Copy full SHA for 925f520

Commits on Mar 1, 2020

• api ref: improve print output of code samples

  jorgeorpinel

  committed
  7105df6

  Copy full SHA for 7105df6

Commits on Mar 2, 2020

• api ref: few text edits to match to core repo docstrings

  jorgeorpinel

  committed
  a02b178

  Copy full SHA for a02b178

• api ref: correct docs about UrlNotDvcRepoError – it only exists in get_url

  jorgeorpinel

  committed
  466694c

  Copy full SHA for 466694c

Commits on Mar 3, 2020

• suggest some minor things to API

  shcheklein

  committed
  951742d

  Copy full SHA for 951742d

• Update public/static/docs/api-reference/get_url.md

  Show description for 410622f
  

  shcheklein

  and

  jorgeorpinel

  authored
  410622f

  Copy full SHA for 410622f

Commits on Mar 4, 2020

• Merge pull request #1032 from iterative/api-suggestions

  Show description for fcbdefd
  jorgeorpinel

  authored
  fcbdefd

  Copy full SHA for fcbdefd

• api ref: address remaining feedback from PR #1032

  jorgeorpinel

  committed
  8089423

  Copy full SHA for 8089423

• typo

  jorgeorpinel

  committed
  e440284

  Copy full SHA for e440284

• api ref: apply get_url improvements to open and read fns

  Show description for 4ee9335
  jorgeorpinel

  committed
  4ee9335

  Copy full SHA for 4ee9335

Commits on Mar 5, 2020

• api ref: add info. about types returned/generated to open and read

  jorgeorpinel

  committed
  6cd45b0

  Copy full SHA for 6cd45b0

• api ref: minor changes to open

  jorgeorpinel

  committed
  ce5b42a

  Copy full SHA for ce5b42a

Commits on Mar 8, 2020

• Merge branch 'master' into api

  jorgeorpinel

  committed
  f245cc8

  Copy full SHA for f245cc8

• api ref: address another round of feedback on open fn

  Show description for 6bd2740
  jorgeorpinel

  committed
  6bd2740

  Copy full SHA for 6bd2740

• api ref: small change to reaf fn example title

  Show description for 90cb882
  jorgeorpinel

  committed
  90cb882

  Copy full SHA for 90cb882

• api ref: a few last improvements it seems

  jorgeorpinel

  committed
  7733fea

  Copy full SHA for 7733fea