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.

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

Improve htmlbox description #3104

Merged
merged 1 commit into from
Jan 29, 2024
Merged

Improve htmlbox description #3104

merged 1 commit into from
Jan 29, 2024

Conversation

JorjMcKie
Copy link
Collaborator

Some clarifying formulation.
Also correct the reference to parameter "scale_low".

@JorjMcKie JorjMcKie requested a review from jamie-lemon January 27, 2024 21:20
docs/page.rst Outdated
:arg float scale_low: if necessary scale down the content until it fits in the target rectangle. This sets the down scaling limit. Default is 0, no limit. A value of 1 means no down-scaling. A value of e.g. 0.2 means maximum down-scaling by 80%.
:arg Archive archive: an Archive object that points to locations where to find images or non-standard fonts. If `text` refers to images, this parameter is always reqired. Ignored if `text` is a Story.
:arg float scale_low: if necessary, scale down the content until it fits in the target rectangle. This sets the down scaling limit. Default is 0, no limit. A value of 1 means no down-scaling permitted. A value of e.g. 0.2 means maximum down-scaling by 80%.
:arg Archive archive: an Archive object that points to locations where to find images or non-standard fonts. If `text` refers to images or non-standard fonts, this parameter is reqired. Ignored if `text` is a Story.
Copy link
Collaborator

Choose a reason for hiding this comment

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

reqired -> required

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank Jamie - corrected.

Some clarifying formulation.
Also correct the reference to parameter "scale_low".
@jamie-lemon jamie-lemon merged commit c18b012 into main Jan 29, 2024
2 checks passed
@jamie-lemon jamie-lemon deleted the Harald-doc-changes branch January 29, 2024 22:30
@github-actions github-actions bot locked and limited conversation to collaborators Jan 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants