Skip to content

SG-34983 Documentation title changed from API3 to API #339

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

Merged
merged 6 commits into from
Apr 30, 2024
Merged

SG-34983 Documentation title changed from API3 to API #339

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
26f28bb
documentation title changed from Flow Production Tracking Python API3…
eduardoChaucaGallegos Apr 26, 2024
88b203d
deleting # to be align with text
eduardoChaucaGallegos Apr 26, 2024
6b4a724
library suffix added in tittle
eduardoChaucaGallegos Apr 26, 2024
1295cfd
Added a new note to inform that FPTR API 3 is also known as Python API
eduardoChaucaGallegos Apr 29, 2024
1014e13
corrections about text and aclaration about python API is ready
eduardoChaucaGallegos Apr 29, 2024
b55656f
correction about short version text
eduardoChaucaGallegos Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
####################################
Flow Production Tracking Python API3
####################################
###########################################
Flow Production Tracking Python API library
###########################################
Release |version|. (:ref:`Installation <installation>`)

.. image:: https://img.shields.io/badge/shotgun-api-blue.svg
Expand All @@ -17,6 +17,9 @@ Because the needs of every studio can prove to be very different, we don't inclu
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.

.. note::
It's very important to know that Python API is also known as Flow Production Tracking API 3 (FPTR API 3).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


.. _pythonoverviewvideo:

Overview Video of Setting Up Your Environment with the Python API
Expand Down