fix: simplify linkup import with aliases and some cleanup#70
Merged
Conversation
This follows our internal convention. Rumdl is faster and has more features (like dealing well with front-matters) than mdformat.
We decided to move most of the documentation in our API documentation, so let's only keep the examples mentioned in the README.
Shedna
approved these changes
May 21, 2026
This will make possible to import linkup with `import linkup` and use it with `linkup.Client()` which is more concise and follows the google style guide recommendation for imports, which is to only import modules. Former import style is left and will be kept in the foreseeable future.
cjumel
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This follows our internal convention. Rumdl is faster and has more features (like dealing well with front-matters) than mdformat.
We decided to move most of the documentation in our API documentation, so let's only keep the examples mentioned in the README.
This will make possible to import linkup with
import linkupand use it withlinkup.Client()which is more concise and follows the google style guide recommendation for imports, which is to only import modules. Former import style is left and will be kept in the foreseeable future.Checklist
prekon this project (for instance with themake install-devcommand)before creating any commit, or I have run successfully the
make lintcommand on my changes.make typecheck testcommand on my changes.README.mdif my changes affected it.