Skip to content

feat: add support for placeholder escaping, prep for release, misc #247

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

Merged
merged 6 commits into from
Jun 29, 2024

Conversation

kbdharun
Copy link
Member

@kbdharun kbdharun commented Jun 28, 2024

Changes

  • Add support for placeholder escaping to comply with the latest specification.
  • Add "tldr-pages contributors" to the copyright name beside the original client author.
  • Remove the contact email of the original author since they aren't involved anymore.
  • Update PyPi categories in setup.py adding Python 3.12 and BSD platforms as supported.
  • Update the docs directory in the .gitignore file and add a man page for local builds (Build wheel unable to find documentation files (building from 2024-02-24 repo) #233).
  • Update Snapcraft (snap) config to core24 (Ubuntu LTS 24.04) and Python 3.12 (also removed some unnecessary comments).
  • Minor fixes to README and add Snap release badge.
  • Add CHANGELOG, bump, and client spec versions to 3.3.0 and v2.2, respectively.

I have been working on this since yesterday, and the changes are finally done. After this PR's merge, I will create a new release and once it is done will bump the Snapcraft files version.

This time the changelog is really big xD.


Related issues

Sample Screenshots

Placeholder escaping

image

image

image

For more details check out https://github.com/search?q=repo%3Atldr-pages%2Ftldr+%5C%7B%5C&type=code

New badge in README

image

@kbdharun kbdharun added this to the 3.3.0 milestone Jun 28, 2024
Signed-off-by: K.B.Dharun Krishna <[email protected]>
@patricedenis
Copy link
Contributor

It looks good ! All of those improvements, congrats @kbdharun and thanks !
I found a few minor addition that I could suggest, I will add them shortly.

@kbdharun
Copy link
Member Author

I found a few minor addition that I could suggest, I will add them shortly.

If it's related to the PR feel free to suggest it here, if it's a new feature/minor update sure we can add it later.

@patricedenis
Copy link
Contributor

Yeah thanks, I've just made a PR to this branch because I was not able to add it directly from the review process.

@patricedenis
Copy link
Contributor

patricedenis commented Jun 28, 2024

Ok @kbdharun : my PR on the brand does not seem to wook properly.
The suggestion was to replace the line 60 on README.md from :
[linux, osx, sunos, windows, common]
to
[android, linux, osx, sunos, windows, freebsd, netbsd, openbsd, common]

or better : android, freebsd, linux, netbsd, openbsd, osx, sunos, windows, common
as you had written in the man doc.

Signed-off-by: K.B.Dharun Krishna <[email protected]>
@kbdharun kbdharun merged commit 3bc6ba4 into main Jun 29, 2024
18 checks passed
@kbdharun kbdharun deleted the feat/prep-release branch June 29, 2024 04:26
@kbdharun kbdharun removed the request for review from vitorhcl June 29, 2024 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Plans for new release? Build wheel unable to find documentation files (building from 2024-02-24 repo)
4 participants