Skip to content

Comment alignment when spaces_before_comment is a list #989

Description

@01tot10

Hey all!

I've just started using yapf with hopes for making easier the burden of code-cleanup.

I very much like the aesthetics of aligned comments when it comes to blocks of code, but having a list of values in spaces_before_comment kinda creates problems when I have blocks with comments on the side, as well as commented out lines.

I can imagine comments and commented out lines within a block are hard to distinguish programmatically, but is there something in yapf that would allow for not having the problem, where:

from torch.utils.data import DataLoader # this is an important comment
import numpy as np
# import torch
import matplotlib.pyplot as plt
# import sounddevice as sd
# import os
# import torchaudio

gets corrected to:

from torch.utils.data import DataLoader # this is an important comment
import numpy as np
                                        # import torch
import matplotlib.pyplot as plt
                                        # import sounddevice as sd
                                        # import os
                                        # import torchaudio

Thank you in advance!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions