SG-34983 Documentation title changed from API3 to API

[eduardoChaucaGallegos]

Documentation title changed from Flow Production Tracking Python API3 to Flow Production Tracking Python API

[carlos-villavicencio-adsk]

We always have this confusion when users think this repository is the actual API while it's really an API client/wrapper/library.

I'd propose to change this name to

Suggested change

	Flow Production Tracking Python API
	Flow Production Tracking Python API library

or

Suggested change

	Flow Production Tracking Python API
	Flow Production Tracking Python API client

If @julien-lang agrees, we should change it too in the README and in every documentation page when it mentions Flow Production Tracking Python API.

[julien-lang]

I agree with all that but this might be beyond the current ticket.
I think the "library" suffix is a good idea.

[carlos-villavicencio-adsk]

@eduardoChaucaGallegos Let's add "library" for this title only, we can update the rest of the documentation later.

Thanks!

[julien-lang]

Good start, could you add a paragraph somewhere saying that the Python API is also known as the FPTR API3.

[julien-lang]

I agree with all that but this might be beyond the current ticket.
I think the "library" suffix is a good idea.

[carlos-villavicencio-adsk]

[julien-lang]

@eduardoChaucaGallegos please add a small paragraph somewhere saying the Python API is also known as FPTR API 3.

[eduardoChaucaGallegos]

@eduardoChaucaGallegos please add a small paragraph somewhere saying the Python API is also known as FPTR API 3.

Hi @julien-lang, I just added a new paragraph as a note block with your recommendation, let me know if it seems correct to you. I have a small doubt because in your comments you talk about placing "FPTR API 3" in this new note block, because the goal of this ticket is to remove the suffix 3 from the title, shouldn't it be the same for the text you recommend? (without the 3, so maybe only FPTR API )

[julien-lang]

I think we should edit the 2 first paragraph instead of adding a note:

diff --git a/docs/index.rst b/docs/index.rst
index 5eef5a6..88dcdc7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,21 +1,21 @@
 ####################################
-Flow Production Tracking Python API3
+Flow Production Tracking Python API
 ####################################
 Release |version|. (:ref:`Installation <installation>`)
 
 .. image:: https://img.shields.io/badge/shotgun-api-blue.svg
 
-
-
-Flow Production Tracking provides a simple Python-based API for accessing Flow Production Tracking and integrating with other tools.
-The Flow Production Tracking API allows users to integrate their tools with Flow Production Tracking very easily. Using this simple
-but powerful python module , you can quickly get your scripts integrated with Flow Production Tracking's CRUD-based
-API.
+Flow Production Tracking (FPTR) provides a simple Python-based API for accessing
+FPTR and integrating with other tools.
+The Flow Production Tracking API3, also known as "Python API", allows users to
+integrate their tools with Flow Production Tracking very easily.
+Using this simple but powerful python module , you can quickly get your scripts
+integrated with Flow Production Tracking's CRUD-based API.
 
 Because the needs of every studio can prove to be very different, we don't include a lot of
 "automation" or "smarts" in our API. We have kept it pretty low-level and leave most of those
 decisions to you. The API is powerful enough you can write your own "smarts" in a wrapper on top
-of the Flow Production Tracking API.
+of the FPTR API3.
 
 .. _pythonoverviewvideo:
 

Also, please check the rest of the documents see if there are any other references to "Python API3" or API3 and make sure it's accurate.

[julien-lang]

Looks good. Only one minor change and I'll approve it.

[julien-lang]

You need to use the long version because the short version has not being defined in this document yet

Suggested change

	Below is a list of helpful tips when using the FPTR API3. We have tried to make the API very
	Below is a list of helpful tips when using the Flow Production Tracking API3. We have tried to make the API very

[julien-lang]

LGTM!