Skip to content

#408 Add comment explaining render() wrapper delegates to Renderer fo… - #411

Open
ahmedmajid22 wants to merge 3 commits into
mainfrom
408-comment-render-wrapper-pickomino
Open

ahmedmajid22 wants to merge 3 commits into
mainfrom
408-comment-render-wrapper-pickomino

Conversation

@ahmedmajid22

Copy link
Copy Markdown
Collaborator

Description

Add comment to explain why the render() wrapper in pickomino.py exists.

Related Issue

Closes #408

Changes

  • Added comment in render() explaining the wrapper delegates to Renderer because renderer.py uses a try/except ImportError for importlib.resources compatibility
  • Removed unused type: ignore[override] comment

Testing

  • Tests added/updated
  • Passes pre-commit hooks
  • Test coverage maintained (95%+)

@ahmedmajid22

Copy link
Copy Markdown
Collaborator Author

The main idea for the issue here is to write a comment explaining the reason why the render function is here.
Which is a wrapper for the function below it and is used because we want to do the value error

@jarl-hoyem jarl-hoyem left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Too many unneeded quotes changes only.
type ignore is irrelevant to issue
comment should be in docstring and reference ValueError.

This branch has not been deployed

No deployments
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.

Comment on why there is a rendere() wrapper in pickomino.py

2 participants