Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Code Style and Naming

See original GitHub issue

When we have the first integrated version skorch-api+dataset, we can make a pass over the code to enforce some more consistency and see what style we prefer (beyond just pep8).

Let’s collect open questions for now:

  • to indicate a variable that specifies an index/counter, e.g., the index of a trial, should we prefix with i(=i_trial) or with idx=idx_trial

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:19 (11 by maintainers)

github_iconTop GitHub Comments

robintiborcommented, May 6, 2020

based on all of this how about:

  • Trial
  • (Compute) Window -> we use compute_window at some public function calls to give a strong hint at the beginning, internally can use shorter “window”
  • Crop, stays as crop to stay consistent with paper, mostly used in internal code
agramfortcommented, Feb 7, 2020

one word that pops to mind is also “segment” that point more directly to data / signals while annotations refers to the target variable.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Naming convention (programming) - Wikipedia
In computer programming, a naming convention is a set of rules for choosing the character sequence to be used for identifiers which denote...
Read more >
Coding best practices
Variable naming is an important aspect in making your code readable. Naming variables follow a simple idea: Create variables that describe their function ......
Read more >
Code-style naming rules - .NET - Microsoft Learn
Default naming styles · For classes, structs, enumerations, properties, methods, and events with any accessibility, the default naming style is ...
Read more >
Naming Convention — 9 Basic Rules for any Piece of Code
Naming convention should be generic, and as professional as possible, and should not include any cultural slang. Rule #7 — Be Positive.
Read more >
Programming Naming Conventions – Camel, Snake, Kebab ...
Style guides are available for more or less all popular programming languages. Here are some of the most commonly used:
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found