• last updated 15 hours ago
Constraints
Constraints: committers
 
Constraints: files
Constraints: dates
Fix parameter name in proc doc

Fix parameter names in proc doc

Fix parameter names in proc doc

Whitespace changes

  1. … 1 more file in changeset.
Whitespace changes

    • -56
    • +56
    ./tcl/application-data-link-procs.tcl
  1. … 1 more file in changeset.
Fix parameter names and descriptions in proc doc

Fix misleading and uncoherent 'apm_data_model_scripts_find' proc documentation

Fix parameter names in proc doc

Whitespace changeds

    • -261
    • +261
    ./tcl/deprecated-procs.tcl
Harmonize parameter names in proc documentation removing unnecessary hyphens

  1. … 1 more file in changeset.
Fix parameter name

Allow square brackets in proc doc. In particular, this fixed a false positive with [doc_string] in 'ad_proc'

Improve 'args' check in 'documentation__check_parameters' test case by using the built-in 'varargs_p' variable.

Add 'args' parameter to the real parameter list of the 'documentation__check_parameters', as it is not included into 'switches' or 'positionals'.

Use 'apm_get_package_files -file_types' instead of filtering the 'www' and 'lib' directories manually.

Take care of '_p' boolean parameters when checking for discrepancies between real and documented proc parameters.

Overhaul of test cases:

- make tested API calls explict

- reduce dependency on twt

    • -1
    • +98
    ./tcl/test/apm-parameter-test-procs.tcl
    • -113
    • +141
    ./tcl/test/application-data-link-procs.tcl
    • -8
    • +28
    ./tcl/test/community-core-test-procs.tcl
    • -15
    • +33
    ./tcl/test/datamodel-test-procs.tcl
    • -29
    • +174
    ./tcl/test/html-conversion-procs.tcl
    • -12
    • +20
    ./tcl/test/openacs-kernel-procs.tcl
    • -12
    • +21
    ./tcl/test/test-membership-rel-procs.tcl
  1. … 4 more files in changeset.
don't leak user_ids from regression test case

    • -10
    • +9
    ./tcl/test/community-core-test-procs.tcl
make tested API calls explicit

    • -7
    • +23
    ./tcl/test/site-nodes-test-procs.tcl
prefer built-in ns_dbquotevalue over DoubleApos

make former private functions, used in several packages to public functions

improve spelling

  1. … 2 more files in changeset.
Add new test case 'documentation__check_parameters', which checks if parameters defined in the proc doc (@param) are really proc parameters.

Sometimes proc parameter changes are not reflected in the proc doc, this should take care of some of these cases.

improve spelling

Improve the list of common typos for the 'documentation__check_typos' test case, including some from Wikipedia: https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines

    • -1
    • +3354
    ./tcl/test/doc-check-procs-common-typos.txt
Remove apparent leftover + trailing whitespace

Add new test case 'files__page_contracts', which checks for the existance of both 'ad_page_contract' and 'ad_include_contract' in the .tcl files inside 'www' and 'lib' package directories.

There are cases, where includelets are not stored in 'lib' but 'www', or have 'ad_page_contract' instead of 'ad_include_contract'. Checking if the location of includelets is correct is not so clear, so we avoid doing this in this particular test.

rework test case documentation__check_typos

- make test case more robust (don't abort tests when there is a proc_doc without a "main" section

- improve performance and sanity:

* move invariantes out of the loop

* use built-in hashes

* don't check the same term multiple times

... times went from >15 sec to <1sec

remove useless semicolon

Add new test case 'files__trailing_whitespace', which looks for trailing whitespace (spaces or tabs at the end of lines).

Currently, only .tcl files are checked.