Skip to content

Commit

Permalink
typo fixed in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pitchmuc committed Apr 26, 2021
1 parent bd99d60 commit 0eb071e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion aanalytics2/aanalytics2.py
Original file line number Diff line number Diff line change
Expand Up @@ -1395,7 +1395,7 @@ def getAllProjectDetails(self, projects:JsonListOrDataFrameType=None, filterName
filterNameOwner : OPTIONAL : If you want to retrieve project details for project with an owner having a specific name.
useAttribute : OPTIONAL : True by default, it will use the projectList saved in the listProjectIds attribute.
If you want to start from scratch on the retrieval process of your projects.
rsidSuffix : OPTIONAL : If you want to add rsid as suffix of metrics and dimension (::rsid)
rsidSuffix : OPTIONAL : If you want to add rsid as suffix of metrics and dimensions (::rsid)
cache : OPTIONAL : If you want to cache the different elements retrieved for future usage.
verbose : OPTIONAL : Set to True to print information.
Not using filter may end up taking a while to retrieve the information.
Expand Down
1 change: 1 addition & 0 deletions docs/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ Therefore there are 4 optional parameters that can definitely save you a lot of
* useAttribute : OPTIONAL : `True` by default, it will use the projectList saved in the `listProjectIds` attribute of your instance.
It avoids to recreates the call and can save several seconds.
If you want to start from scratch on the retrieval process of your projects, set it to `False`.
* rsidSuffix : OPTIONAL : If you want to add rsid as suffix of metrics and dimensions (::rsid)

## Find the components used

Expand Down
5 changes: 3 additions & 2 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ The changes have been tracked starting version 0.1.0

## version 0.2.7

* adding `compareReportSuites` method
* adding `compareReportSuites` method. ([documentation](https://github.com/pitchmuc/adobe-analytics-api-2.0/blob/master/docs/main.md#compare-reportsuite))
* adding `reportType` as attribute from projects. Either `desktop` or `mobile`
* adding `version` and `curation` attributes by default on dict version of `project`.
* adding `scanSegment` and `scanCalculatedMetric` methods.
* adding `scanSegment` and `scanCalculatedMetric` methods. ([documentation](https://github.com/pitchmuc/adobe-analytics-api-2.0/blob/master/docs/main.md#the-scan-methods))
* adding `rsidSuffix` parameter for `Project` class ([documentation](https://github.com/pitchmuc/adobe-analytics-api-2.0/blob/master/docs/projects.md#project-class)), `findComponentUsage` ([documentation](https://github.com/pitchmuc/adobe-analytics-api-2.0/blob/master/docs/projects.md#find-the-components-used)) and `getAllProjectDetails` ([documentation](https://github.com/pitchmuc/adobe-analytics-api-2.0/blob/master/docs/projects.md#project-class))

## version 0.2.6

Expand Down

0 comments on commit 0eb071e

Please sign in to comment.