Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
* set no advanced_quals_path by default
* add note to docs
  • Loading branch information
deargle committed Apr 12, 2021
1 parent 235ff82 commit ffe13ad
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 4 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- user_utils.PsiTurkAuthorization should not allow empty username or password! (#492)

### Added
- Add custom MTurk qualification support (#493)

## [3.1.0]
### Added
- ability to launch the experiment server from a subdirectory instead of just
Expand Down
16 changes: 16 additions & 0 deletions doc/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,22 @@ workers with that qualification already set will neither see your ad nor be able
to accept your HIT. This is the recommended way of excluding participants who
have performed other HITs for you from participating in your new HIT.

.. _advanced_quals:

advanced_quals_path
~~~~~~~~~~~~~~~~~~~

A path to a custom JSON qualifications file, where you can define your own
MTurk qualification requirements, as seen in `advanced_quals.json.sample`__

__ https://raw.githubusercontent.com/NYUCCL/psiTurk/master/psiturk/example/advanced_quals.json.sample

:type: ``path``

Example::

advanced_quals_path = ./advanced_quals.json


.. _hit_configuration_ad_url:

Expand Down
8 changes: 5 additions & 3 deletions psiturk/example/config.txt.sample
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@

# A path to a custom JSON qualifications file, where you can define your own
# MTurk qualification requirements, as seen in advanced_quals.json.sample
;advanced_quals_path = ./advanced_quals.json
# Example:
# ;advanced_quals_path = ./advanced_quals.json
;advanced_quals_path =

## Hit Configuration - Ad Url ##################################################
# Config settings for constructing the task's "landing page"
Expand All @@ -78,7 +80,7 @@
# you may uncomment and use `ad_url`. You may want to use this if your
# experiment is served from a subdirectory off of the domain name. Otherwise,
# leave this as-is.
;;ad_url = %(ad_url_protocol)s://%(ad_url_host)s:%(ad_url_port)s/%(ad_url_route)s
;ad_url = %(ad_url_protocol)s://%(ad_url_host)s:%(ad_url_port)s/%(ad_url_route)s

############################## Database Parameters #############################
[Database Parameters]
Expand Down Expand Up @@ -111,7 +113,7 @@
;errorlog = server.log
# For backwards compatibility, `logfile` is synonymous with `errorlog`. If
# both are set, `errorlog` will be preferred over `logfile`.
;;logfile = server.log
;logfile = server.log

# Log level for the psiturk gunicorn server
;loglevel = 2
Expand Down
2 changes: 1 addition & 1 deletion scripts/create_sample_config_from_defaults.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
f'# Example config file. Uncomment lines (remove the `;`)\n'
f'# in order to override defaults.\n'
)
if len(line) > 1 and line[0] not in ['#', '[']: # every line will have at least an \n char
if len(line) > 1 and line[0] not in ['#', '[', ';']: # every line will have at least an \n char
line = f';{line}'
new_lines.append(line)
line_num += 1
Expand Down

0 comments on commit ffe13ad

Please sign in to comment.