-
Notifications
You must be signed in to change notification settings - Fork 204
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.
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
eduardoChaucaGallegos
merged 6 commits into
master
from
ticket/SG-34983-misleading-information-about-documentation-title
Apr 30, 2024
Merged
Changes from 2 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 88b203d
deleting # to be align with text
eduardoChaucaGallegos 6b4a724
library suffix added in tittle
eduardoChaucaGallegos 1295cfd
Added a new note to inform that FPTR API 3 is also known as Python API
eduardoChaucaGallegos 1014e13
corrections about text and aclaration about python API is ready
eduardoChaucaGallegos b55656f
correction about short version text
eduardoChaucaGallegos File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
or
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.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with all that but this might be beyond the current ticket.
I think the "library" suffix is a good idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@eduardoChaucaGallegos Let's add "library" for this title only, we can update the rest of the documentation later.
Thanks!