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

api: stabilise and document #95

Open
2 of 6 tasks
tiborsimko opened this issue Jul 18, 2016 · 4 comments
Open
2 of 6 tasks

api: stabilise and document #95

tiborsimko opened this issue Jul 18, 2016 · 4 comments
Assignees
@egabancho @nharraud @JavierDelgadoFernandez
Labels
Need: information Service: B2SHARE Status: in work
Milestone
I3B-API-Docs

Comments

@tiborsimko
Copy link
Member

tiborsimko commented Jul 18, 2016 •
edited by hachreak
Loading

  • check existing API functionality
  • add missing important API functionality
  • check API function signatures and parameters
  • enhance API docstrings (param, returns, raises, versionadded)
  • plug API functions to existing docs
@tiborsimko tiborsimko added this to the I3B-API-Docs milestone Jul 18, 2016
@hachreak hachreak self-assigned this Jul 21, 2016
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 22, 2016
docs: improve documentation
e2e5144 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
@hachreak hachreak mentioned this issue Jul 22, 2016
Merged
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 22, 2016
docs: improve documentation
eba734b 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 22, 2016
docs: improve documentation
247d30e 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 22, 2016
docs: improve documentation
1c48fe2 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 22, 2016
docs: improve documentation
6451ffb 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 25, 2016
docs: improve documentation
cf0c16d 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 25, 2016
docs: improve documentation
2a06ff2 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 25, 2016
docs: improve documentation
9b0d61a 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 25, 2016
docs: addition of param and result sections
dd8e40a 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 26, 2016
docs: addition of param and result sections
9575962 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 27, 2016
docs: addition of param and result sections
0d4e284 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 27, 2016
docs: addition of param and result sections
67ee421 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 27, 2016
docs: addition of param and result sections
ca1dca9 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 28, 2016
docs: addition of param and result sections
b3880b2 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 28, 2016
docs: addition of param and result sections
86a67bd 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 28, 2016
docs: addition of param and result sections
67f9aad 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 28, 2016
docs: addition of param and result sections
2d5ee11 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 28, 2016
docs: addition of param and result sections
5d4d840 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 28, 2016
docs: addition of param and result sections
bc7ab90 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 29, 2016
docs: addition of param and result sections
bea0757 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
hachreak pushed a commit to hachreak/invenio-deposit that referenced this issue Jul 29, 2016
docs: addition of param and result sections
180b50f 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
@hachreak
Copy link
Member

hachreak commented Aug 2, 2016

@jirikuncar @lnielsen do you think the first 3 points are fine? Or do we need to improve somehow the API?

@jirikuncar
Copy link
Member

There was an API improvement in 352336b.

It would be nice to hear also from @nharraud and @JavierDelgadoFernandez if they managed to integrate current version to B2Share and CAP without any major issue.

@nharraud nharraud mentioned this issue Aug 3, 2016
Closed
@hachreak
Copy link
Member

hachreak commented Aug 3, 2016

Also from @egabancho for CDS

drjova pushed a commit to drjova/invenio-deposit that referenced this issue Aug 3, 2016
@drjova
docs: addition of param and result sections
90a087b 
* Improves documentation. (addresses inveniosoftware#95)

Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
@egabancho
Copy link
Member

We don't have a "current" deposit in our overlay, we are baking the first one now ☺️

@hachreak hachreak removed their assignment Sep 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@egabancho egabancho

@nharraud nharraud

@JavierDelgadoFernandez JavierDelgadoFernandez

Labels
Need: information Service: B2SHARE Status: in work
Projects
None yet
Milestone
I3B-API-Docs
Development

No branches or pull requests
6 participants
@jirikuncar @hachreak @tiborsimko @egabancho @nharraud @JavierDelgadoFernandez