Skip to content

Commit

Permalink
[Documentation] Skip AMDA user products access from doctest
Browse files Browse the repository at this point in the history
GH Actions blocks secrets for pull requests from forks, which makes sense
since it wouldn't be safe. So we can't test user product access from
documentation examples. One improvement would be to find how to skip them
conditionally on PR or when no credentials are available.

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
  • Loading branch information
jeandet committed Jan 24, 2022
1 parent bcbe975 commit e9673ea
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/user/amda/amda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,14 @@ Then if you correctly typed your login you should be able to list and get user p

>>> from speasy import amda
>>> # list user products
>>> amda.list_user_parameters()
>>> amda.list_user_parameters() # doctest: +SKIP
[<ParameterIndex: test_param>]
>>> amda.list_user_catalogs()
>>> amda.list_user_catalogs() # doctest: +SKIP
[<CatalogIndex: MyCatalog>]
>>> amda.list_user_timetables()
>>> amda.list_user_timetables() # doctest: +SKIP
[<TimetableIndex: test_alexis>, <TimetableIndex: test_alexis2>, <TimetableIndex: tt3>]
>>> # get my first user catalog
>>> amda.get_user_catalog(amda.list_user_catalogs()[0])
>>> amda.get_user_catalog(amda.list_user_catalogs()[0]) # doctest: +SKIP
<Catalog: MyCatalog>


Expand Down

0 comments on commit e9673ea

Please sign in to comment.