Skip to content

Add docs custom send button label & icon optional keyword args#904

Merged
nonprofittechy merged 2 commits intomainfrom
903_send_label_no_doubles
Feb 12, 2025
Merged

Add docs custom send button label & icon optional keyword args#904
nonprofittechy merged 2 commits intomainfrom
903_send_label_no_doubles

Conversation

@plocket
Copy link
Copy Markdown
Collaborator

@plocket plocket commented Feb 11, 2025

Closes #903, let author customize send button label and icon with keyword arguments. Added:

  • keyword args
  • types
  • docstrings
  • to download_list_html()
  • to send_email_table_row()
  • to send_button_html()
  • to the test file

send_button_html() already had these options as label and icon.

@plocket
Copy link
Copy Markdown
Collaborator Author

plocket commented Feb 11, 2025

A couple issues with the tests:

  • ALKiln can't set up the test because it keeps getting a 504. Not sure what's going on, but no time to look into it at the moment. [I did test this manually.]
  • I don't see a pull request from black-formatting

@nonprofittechy
Copy link
Copy Markdown
Member

Black doesn't do a PR anymore. You need to do on command line.

I'll ignore the kiln failure , but let's get this migrated to GitHub only testing!

@plocket
Copy link
Copy Markdown
Collaborator Author

plocket commented Feb 12, 2025

Shall I just look up a run-of-the-mill tutorial on black, or are we doing anything special?

@plocket plocket force-pushed the 903_send_label_no_doubles branch from e26d7f0 to 555ecd9 Compare February 12, 2025 01:47
@nonprofittechy
Copy link
Copy Markdown
Member

Shall I just look up a run-of-the-mill tutorial on black, or are we doing anything special?

Just pip install black, then black .

@plocket
Copy link
Copy Markdown
Collaborator Author

plocket commented Feb 12, 2025

It's docsig main that seems to be failing at the moment [with "unknown option to disable 'E113'"]. If I have time today, I'll look into that.

@nonprofittechy
Copy link
Copy Markdown
Member

We'll fix this in a separate PR. it looks like Docsig no longer supports the option to ignore error E113 (missing docstring).

docsig .
docassemble/AssemblyLine/al_courts.py:32 in ALCourt.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_courts.py:211 in ALCourtLoader.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_courts.py:235 in ALCourtLoader.unique_column_values
    SIG506: description missing from return (return-description-missing)
docassemble/AssemblyLine/al_document.py:251 in ALAddendumField.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_document.py:755 in ALAddendumFieldDict.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_document.py:993 in ALDocument.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_document.py:1348 in ALStaticDocument.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_document.py:1518 in ALDocumentBundle.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_document.py:2531 in ALExhibit.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_document.py:2751 in ALExhibitList.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_general.py:282 in ALAddress.formatted_unit
    SIG506: description missing from return (return-description-missing)
docassemble/AssemblyLine/al_general.py:618 in ALAddress.normalized_address
    SIG506: description missing from return (return-description-missing)
docassemble/AssemblyLine/al_general.py:683 in ALAddressList.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_general.py:705 in ALNameList.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_general.py:723 in ALPeopleList.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/al_general.py:877 in ALIndividual.init
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/language.py:27 in get_local_languages_yaml
    SIG101: function is missing a docstring (function-doc-missing)
docassemble/AssemblyLine/project_maintenance.py:341 in main

@nonprofittechy nonprofittechy merged commit 875e638 into main Feb 12, 2025
3 of 5 checks passed
@nonprofittechy nonprofittechy deleted the 903_send_label_no_doubles branch February 12, 2025 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add custom label parameter to send_button_html() method

2 participants