Skip to content

Commit

Permalink
Revert "Grammar edits"
Browse files Browse the repository at this point in the history
  • Loading branch information
sjkoke authored Nov 28, 2024
1 parent a692445 commit 4dffa30
Show file tree
Hide file tree
Showing 3 changed files with 124 additions and 130 deletions.
10 changes: 5 additions & 5 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
API
***

What is an API?
===============
What's that?
============

An API can be used to read or write data from an external program (such as a Python script) to an eLabFTW instance.
It's a way to read or write data to eLabFTW from an external program (like a Python script).

For instance, instead of using a web browser to access your eLabFTW instance and create an experiment,
you can make a call to the API saying "hey, create an experiment for me", and the api will reply with the ID of the newly created experiment.
For instance, instead of using a web browser to access the web interface and create an experiment,
you make a call to the API saying "hey, create an experiment for me", and the api will reply with the ID of the newly created experiment.

It can be used to directly feed data to eLabFTW, coming from a piece of equipment for instance.

Expand Down
6 changes: 3 additions & 3 deletions doc/generalities.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _generalities:

*******
General
*******
************
Generalities
************

Lexicon
=======
Expand Down
Loading

0 comments on commit 4dffa30

Please sign in to comment.