File extension '.odml'

Open
#338 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
tooling

Research direction

The issue names no files, tests, or entry points. Start by locating where saved filenames and format extensions are handled, then clarify the desired extension behavior for XML, JSON, and YAML before defining tests that establish the accepted naming scheme.

Written by the indexing model from the issue text.

Description

discussion

In a previous version all odml files had the file extension .odml. After support for JSON and YAML was added, the .odml file extension was no longer supported.

Some people still use the .odml file extension, since it makes odml xml files easier to spot.

This issue raises the question whether we could support a compromise solution by adding a secondary .odml.xxx file extension. This makes odml files easy to spot, but keeps the appropriate file format extension which is important e.g. when viewing xml files in a browser or automatically detecting the format via the extension.

As examples, the file extensions of all saved files would look like this:
example.odml.xml, example.odml.json, example.odml.yaml

Dominant language
Python
Stars
25
Forks
30
No merged PRs in 30d

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.

More from G-Node/python-odml

All issues in G-Node/python-odml

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.