rest-for-physics / rest-for-physics/framework

Issue with XML formatting

Open
#269 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
19
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Hi! Since few months ago, a mechanism to reformat XML files was implemented in git to fix the formatting of XML files to a common style. This is really great, however, the resulting XML gets an undesired shape for my taste. The problem is that I like to differentiate groups of parameters or even give some distance between different metadata member definitions (using a line space as it is shown on the following screenshot) that allows me to visualise a relation of proximity between those parameters.

Screenshot 2022-07-26 at 10 11 06

The problem is that after automatic XML formatting the line spaces are removed. Could the white space removal be skipped? Or, perhaps we could avoid XML formatting?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating the git mechanism that reformats XML, then determine whether it can preserve intentional blank lines or be disabled; done means formatting no longer removes the reported spacing without breaking the common XML style.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.