Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Developer Docs - apparent incongruence between existing codebase formatting and results of documented lint operations? #770

Open
@Gewerd-Strauss

Description

@Gewerd-Strauss

Hello,

Okay, this is odd. I am currently setting up a final private branch with all the dirty mods I require for my thesis-project instance; so that I can commit off the various working changes I have and start clean when doing this in a more proper way. Eventhough this is irrelevant as this branch will never leave the private clone, I am trying to adhere to the contribution guidelines outlined in thecontribution- anddeveloper-docs. All linters/checkers are ran with options outlined in the documentations I linked to.

I have 3 main changes I will be adding to my private clone:

  • stripping headers (the thing I will be modularising once we can work on modules inmarkdownpage.py)
  • utf16-handling (I need it, can't wait till we figure this out)
  • some mods tocopy_vault_to_tempdir to exclude filepaths which contain more than 1 dot (.) (private issue, likely never to occur to others, but required for my thesis-instance. Will keep this in and potentially make a notice-issue on the bug itself to see whyexactly this happens)

The first one might be considerable a feature at some point, the secondperhaps, the third most likely not - but whatever.

Back on topic - so I do the mods, and then adhere to the dev-docs when committing:
The dev-docs on contribution-guidelines state that contributors should call the following steps:

  1. runpylint obsidianhtml --errors-only --disable=E0602,E1126:
PS D:\Dokumente neu\Repositories\obsidian-html> pylint obsidianhtml --errors-only --disable=E0602,E1126************* Module obsidianhtml.controller.ConvertVaultobsidianhtml\controller\ConvertVault.py:93:34: E1101: Instance of 'PicknickBasket' has no 'verbosity' member (no-member)obsidianhtml\controller\ConvertVault.py:96:31: E1136: Value 'pb.paths' is unsubscriptable (unsubscriptable-object)obsidianhtml\controller\ConvertVault.py:98:33: E1136: Value 'pb.paths' is unsubscriptable (unsubscriptable-object)************* Module obsidianhtml.core.PicknickBasketobsidianhtml\core\PicknickBasket.py:67:61: E1136: Value 'self.paths' is unsubscriptable (unsubscriptable-object)************* Module obsidianhtml.features.EmbeddedSearchobsidianhtml\features\EmbeddedSearch.py:119:12: E1101: Module 'whoosh.fields' has no 'query' member (no-member)************* Module obsidianhtml.modules.builtin.setup_moduleobsidianhtml\modules\builtin\setup_module.py:108:45: E1120: No valuefor argument 'module_binary'in functioncall (no-value-for-parameter)obsidianhtml\modules\builtin\setup_module.py:108:45: E1120: No valuefor argument 'module_run_method'in functioncall (no-value-for-parameter)

Note that none of the issues pylint flags here are due to modifications I made on my fork

  1. I don't runruff check obsidianhtml because the issue-list is.... humongous (1036 issues)
  2. runblack obsidianhtml pre-commit

Pylint does its job, and doesn't seem to modify much of anything beyond what I did. Stuff I didn't touch doesn't seem to get altered.
Black on the other hand does a whole lot of shit to files I did not work on. I'll be including images here cuz I don't feel like attempting to write a diff-view here. Examples:

grafik
grafik
grafik


As you can see, we have a couple things that change:

  • spaces before/after assignation-=
  • newlines at fileend
  • replace' with" for quotes
  • trimming double-linebreaks to single-linebreaks
  • maybe more I am not seeing

So my questions are:

  1. Was upkeep just left out recently?
  2. Or are there platform-specific indirect changes I am not aware of that makes my instance throw these issues - even in files I never touched beyond a breakpoint?
  3. Or am I just reading the docs incorrectly/are they outdated?
  4. What procedures should be used when committing with the intention to later merge back to the official repo? In a private instance one can be less strict with adhering to standards, but that obviously doesn't help if you intend on contributing this toupstream.

Thank you.
Sincerely,
~Gw

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


      [8]ページ先頭

      ©2009-2025 Movatter.jp