Following Rust naming scheme

[kevaundray]

Problem

This is a tracking issue. There are places where we do not follow the Rust naming guidelines.

See: https://rust-lang.github.io/api-guidelines/naming.html

This file does not list all of the naming rules, so we can add a comment in here to specify ones which are used in the ecosystem but not widely documented. Eg. get_or_init , get_or_compute_foo

Solution

• Fix me

Alternatives considered

Additional context

[kevaundray]

@0xYYY fyi, opened this issue following our discussion

[0xYYY]

noted, thanks a lot, will also update with the cases that i found

[kevaundray]

There are a few places where a method may return either a type T, an Option<T> or a Result<T, Error>. Here is what I suggest:

// This is according to rust naming scheme
fn foo() -> Foo;
// This is also in accordance to the document
fn get_foo() -> Option<Foo>;
fn try_foo() -> Result<Foo, Error>;

Note the document uses: fn get(&self, index: K) -> Option<&V>; but this assumes that there is only one type to return which is the case with a map. If this is also the case for us, then we can unambiguously use that too.

CC @jfecher

[makluganteng]

Can i take this task ?

[kevaundray]

Can i take this task ?

That would be amazing - note:

• This is an continuous issue, so it probably won't be closed.
• if you see a change that needs to be made widespread, I suggest to make a small PR with that change to see if it's something we want to adopt, so it saves you time

[makluganteng]

aa i see maybe i could take on other issue along the way coz its a long term kinda thing

[kevaundray]

aa i see maybe i could take on other issue along the way coz its a long term kinda thing

That would be great!