VH-Lab / VH-Lab/DID-matlab

Consolidate functions for replacing path placeholder with path location

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

Nobody has claimed this yet.

Dominant language
MATLAB
Stars
1
Forks
2
Avg merge
2h 18m
Merged PRs (30d)
39

Description

The following functions seem to have some overlap:

in did.document/readjsonfilelocation:
https://github.com/VH-Lab/DID-matlab/blob/f4248688d49c68030ec2ebf68f4f92860969f281/code/%2Bdid/document.m#L728

in did.database/get_document_schema
https://github.com/VH-Lab/DID-matlab/blob/f4248688d49c68030ec2ebf68f4f92860969f281/code/%2Bdid/database.m#L1051

did.common.utility. replace_didpath
https://github.com/VH-Lab/DID-matlab/blob/f4248688d49c68030ec2ebf68f4f92860969f281/code/%2Bdid/%2Bcommon/%2Butility/replace_didpath.m#L1

Any other places?

Could consolidate this into a set of utility functions.

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

Start by comparing did.document/readjsonfilelocation in code/+did/document.m, did.database/get_document_schema in code/+did/database.m, and did.common.utility.replace_didpath in code/+did/+common/+utility/replace_didpath.m. Search the repository for other path-placeholder replacement logic, then define the shared utility boundaries and verify that the affected document and database behavior remains consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
matlab
Domain
database, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.