tudat-team / tudat-space

An introduction and guide to tudat-space.
https://tudat-space.readthedocs.io
14 stars 17 forks source link

Establish correct lingo for "API documentation" #28

Closed jo11he closed 2 years ago

jo11he commented 2 years ago

While internally we often refer to the API Documentation simply as "API", we should ensure that on tudat-space and all other non-private platforms we use correct terminology.

Valid options:

(*) preferred

TODOs:

jo11he commented 2 years ago

@FilippoOggionni I think concerning point 1 we only need to go over our list of models (I suggest each their own), @DominicDirkx are there any additional pages referring to the API Documentations that you are aware of? If yes, please mention and I will take care of it.

EDIT: @FilippoOggionni possibly also various READMEs.

DominicDirkx commented 2 years ago

My vote goes to: API Documentation

There may be a link on the NA Brightspace page. The main point is updating this on tudat-space. A search all for the term 'API' should do it (?). I did a quick search and replace on a bunch of them (not yet all), and pushed to master. I was having a look, tested to see how easy it was, and decided I might as well push them.

DominicDirkx commented 2 years ago

As a last small point, I modified the remaining entries in tudat-space to sat API documentation (there were one or two where it was, and should be, just API).

FilippoOggionni commented 2 years ago

I think we all agree on API Documentation 👍

I am already replacing it for the list of available acceleration models. @jo11he, if you take care to check the list of available environment models and @DominicDirkx already replaced the rest, I think we are good to go.

DominicDirkx commented 2 years ago

I think I already took care of all of tudat-space (was mostly a search and replace)...

FilippoOggionni commented 2 years ago

Both tasks completed, notification was sent to tudat-space contributors via Slack.