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.

Raw.anonymize() docstring is irritating

See original GitHub issue

When viewing the docs of Raw.anonymize(), I’m confronted with a warning:

If info is part of an object like raw.info, you should directly use the method raw.anonymize() to ensure that all parts of the data are anonymized and stay synchronized (e.g., raw.annotations).

which is irritating because, well, I am reading up on Raw.anonymize already. Also see screenshot below.

Issue Analytics

State:
Created 3 years ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

agramfortcommented, May 23, 2020

date of service can refer to the date at which the MEG system was checked by MEGIN. It’s typically once a year.

0reactions

agramfortcommented, May 24, 2020

I would consider a rephrasing then. Date of acquisition ?

Top Results From Across the Web

Documenting a Python function with a docstring that is both ...

However, as I say in my question, I don't agree that the raw version of option 2 is very readable. I know it's...

Don't write documentation in Markdown | Hacker News

Keeping docs and code as close together as possible. Certainly same repo. But for instance one of pythons greatest feature is docstrings. Which ......

reStructuredText Markup Specification - Docutils - SourceForge

The simplest solution when backslashes appear in Python docstrings is to use raw docstrings: r"""This is a raw docstring. Backslashes (\) are not...

Raw docstring not ignored when computing similarities #2829

Raw docstrings are not ignored with the ignore-docstring=yes in the similarities checker. I think it should be ignored because raw ...

Python Docstrings (With Examples) - Programiz

Python docstrings are the string literals that appear right after the definition of a function, method, class, or module. Let's take an example....