Skip to content
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.

Sign up for GitHub

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

Jump to bottom

documentation fixes #2805

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

documentation fixes #2805

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
55aca83
make doc builder more portable
Habbie Apr 5, 2021
b24a837
fix rendering of hs.dialog.textPrompt examples
Habbie Apr 5, 2021
4272dad
hs.dialog.chooseFileOrFolder: fix documented allowedFileTypes default
Habbie Apr 5, 2021
7ecd624
hs.dialog.chooseFileOrFolder: fix documented return type
Habbie Apr 5, 2021
da19e0b
improve error from build_docs.py
Habbie Apr 5, 2021
85ca71d
hs.timer: fix typo
Habbie Apr 10, 2021
a312dc8
Update build_docs.py
cmsj Dec 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions extensions/dialog/internal.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ static int colorPanelHide(lua_State *L) {

#pragma mark - Choose File or Folder

/// hs.dialog.chooseFileOrFolder([message], [defaultPath], [canChooseFiles], [canChooseDirectories], [allowsMultipleSelection], [allowedFileTypes], [resolvesAliases]) -> string
/// hs.dialog.chooseFileOrFolder([message], [defaultPath], [canChooseFiles], [canChooseDirectories], [allowsMultipleSelection], [allowedFileTypes], [resolvesAliases]) -> table or nil
/// Function
/// Displays a file and/or folder selection dialog box using NSOpenPanel.
///
Expand All @@ -332,7 +332,7 @@ static int colorPanelHide(lua_State *L) {
/// * [canChooseFiles] - Whether or not the user can select files. Defaults to `true`.
/// * [canChooseDirectories] - Whether or not the user can select folders. Default to `false`.
/// * [allowsMultipleSelection] - Allow multiple selections of files and/or folders. Defaults to `false`.
/// * [allowedFileTypes] - An optional table of allowed file types. Defaults to `true`.
/// * [allowedFileTypes] - An optional table of allowed file types. Defaults to allowing all types.
/// * [resolvesAliases] - An optional boolean that indicates whether the panel resolves aliases.
///
/// Returns:
Expand Down Expand Up @@ -679,10 +679,10 @@ static int blockAlert(lua_State *L) {
/// * `buttonOne` defaults to "OK" if no value is supplied.
/// * `buttonOne` will also be triggered by pressing `ENTER`, whereas `buttonTwo` will be triggered by pressing `ESC`.
/// * Examples:
/// `hs.dialog.textPrompt("Main message.", "Please enter something:")`
/// `hs.dialog.textPrompt("Main message.", "Please enter something:", "Default Value", "OK")`
/// `hs.dialog.textPrompt("Main message.", "Please enter something:", "Default Value", "OK", "Cancel")`
/// `hs.dialog.textPrompt("Main message.", "Please enter something:", "", "OK", "Cancel", true)`
/// * `hs.dialog.textPrompt("Main message.", "Please enter something:")`
/// * `hs.dialog.textPrompt("Main message.", "Please enter something:", "Default Value", "OK")`
/// * `hs.dialog.textPrompt("Main message.", "Please enter something:", "Default Value", "OK", "Cancel")`
/// * `hs.dialog.textPrompt("Main message.", "Please enter something:", "", "OK", "Cancel", true)`
static int textPrompt(lua_State *L) {
NSString* defaultButton = @"OK";

Expand Down
6 changes: 3 additions & 3 deletions scripts/docs/bin/build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/python3
#!/usr/bin/env python3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is no longer needed, it was already handled by another PR.

# -*- coding: utf-8 -*-
"""Hammerspoon API Documentation Builder"""

Expand Down Expand Up @@ -320,8 +320,8 @@ def is_actual_parameter(some_text):
parameter_count = len(actual_params)
if parameter_count != sig_arg_count:
warn("SIGNATURE/PARAMETER COUNT MISMATCH: '%s' says %d parameters ('%s'), but Parameters section has %d entries:\n%s\n" % (sig_without_return, sig_arg_count, ','.join(sig_param_arr), parameter_count, '\n'.join(actual_params)))
except:
warn("Unable to parse parameters for %s\n%s\n" % (item["signature"], sys.exc_info()[1]))
except Exception as e:
warn("Unable to parse parameters for %s\n%s\n" % (item["signature"], repr(e)))
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E501 line too long (90 > 79 characters)

sys.exit(1)
return module

Expand Down