`decode_as` argument ordering
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- rust
- Domain
- networking, security
Research direction
Start by locating the several decode_as methods mentioned in the issue, including KeypairData::decode_as, and compare their current signatures and release status. Review the stable public API and prerelease variants before deciding whether the ordering should be consistent; done means the API direction is agreed and the affected methods are handled consistently.
Written by the indexing model from the issue text.
Description
We have several decode_as methods which currently take a reader: &mut impl Reader, algorithm: Algorithm in that order. Most of these are unreleased outside of prereleases (KeypairData::decode_as is the only one in the stable public API).
I'm wondering if this ordering should be reversed so the algorithm comes first, and it reads as decode_as(algorithm, ... rather than decode_as(reader, ...
cc @baloo
- Dominant language
- Rust
- Stars
- 246
- Forks
- 65
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from RustCrypto/SSH
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
RustCrypto/SSH#596 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
RustCrypto/SSH#595 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
RustCrypto/SSH#580 · 3 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 42/100
RustCrypto/SSH#527 · 4 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
RustCrypto/SSH#475 · 10 comments · 1 reaction ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
cmlarsen/writemorebetter#158 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
state:triage-needed
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
scanaislop/aislop#482 ·
Maintainers usually reply within 1 day
-
docs(skills): issue-first should reference an existing Linear ticket instead of filing a duplicateOpendocumentation
Difficulty 1/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day