matthewwithanm / matthewwithanm/python-markdownify
Rename "strip" option to "skip"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.2k
- Forks
- 203
- PR merge metrics
- No merged PRs in 30d
Description
Markdownify's strip configuration option is described as follows:
strip- A list of tags to strip. This option can't be used with theconvertoption.
However, "strip" has a different meaning in Python, which is to remove whitespace from a string. This can be confusing.
This issue requests to rename strip to skip. Feedback is also welcomed on the option name, if there is something better than skip.
For compatibility, we can remap strip to skip for some period of time.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the configuration handling and documentation for the strip option, then inspect any tests covering option behavior. The change is complete when skip is documented and supported, compatibility behavior for strip is defined, and the relevant tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100