-
Notifications
You must be signed in to change notification settings - Fork 2
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
python: generate python pyi stubs #62
Draft
Tristramg
wants to merge
1
commit into
main
Choose a base branch
from
pyi_stubs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains 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
Tristramg
force-pushed
the
pyi_stubs
branch
from
September 19, 2024 15:51
f09fad2
to
2a9fc79
Compare
This allows to have type hints and comments when using the library Signed-off-by: Tristram Gräbener <[email protected]>
Tristramg
force-pushed
the
pyi_stubs
branch
from
September 19, 2024 16:01
2a9fc79
to
7632a4e
Compare
SergeCroise
reviewed
Oct 28, 2024
fn new() -> Self { | ||
Self { | ||
inner: liblrs::builder::Builder::new(), | ||
} | ||
} | ||
|
||
/// Add a new topological node (e.g. a railway switch) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
/// Add a new topological node (e.g. a railway switch) | |
/// Add a new topological node (e.g., a railway switch) |
SergeCroise
reviewed
Oct 28, 2024
/// Add a new segment | ||
/// | ||
/// The geometry represents the curve | ||
/// start_node_index and end_node_index are the topological extremeties returned by `add_node` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
/// start_node_index and end_node_index are the topological extremeties returned by `add_node` | |
/// `start_node_index` and `end_node_index` are the topological extremeties returned by `add_node` |
SergeCroise
reviewed
Oct 28, 2024
@@ -70,6 +74,7 @@ impl From<Point> for geo_types::Coord { | |||
} | |||
} | |||
|
|||
#[gen_stub_pyclass] | |||
#[pyclass] | |||
/// Represent a position on an [`LrmScale`] relative as an `offset` to an [`Anchor`]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
/// Represent a position on an [`LrmScale`] relative as an `offset` to an [`Anchor`]. | |
/// Represents a position on an [`LrmScale`] relative as an `offset` to an [`Anchor`]. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This allows to have type hints and comments when using the library
Closes #61
Marked as draft as upstream dependencies are not met yet