Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Start documenting access to obsidian properties. #2997

Merged
merged 33 commits into from
Jul 31, 2024
Merged

docs: Start documenting access to obsidian properties. #2997

merged 33 commits into from
Jul 31, 2024

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

  • Documentation (prefix: docs - improvements to any documentation content for users)
  • Sample vault (prefix: vault - improvements to the Tasks-Demo sample vault)

Internal changes:

  • Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Description

  • Start documenting access to frontmatter properties.

Motivation and Context

Getting ready to release access to Frontmatter Properties in Task files.

See:

How has this been tested?

Viewing the docs in Obsidian.

Screenshots (if appropriate)

Checklist

Terms

@claremacrae
test: . Extract function verifyFieldDataFromTasksForReferenceDocs()
000b36f
@claremacrae
test: Add some frontmatter/properties values to TaskProperties.test.ts
86e433d
@claremacrae
test: Add another task and more meaningful tags
c6f3024 
... to sample file docs_sample_for_task_properties_reference.md
@claremacrae
docs: Show use of task.file.hasProperty & task.file.property
3fead25
@claremacrae
test: - Add failing test showing problem accessing tag lists via Task…
210f59f 
…sFile
@claremacrae
fix: Allow TasksFile.tags() to be called on TasksFile without CachedM…
97385c4 
…etadata

This only matters for unit-test purposes, where in the previous implementation,
the data needed by the mock getAllTags() could have been replaced
by the time getAllTags() was called in a test.
@claremacrae
test: Demo task.file.frontmatter.tags & task.file.tags
2ea4ae8
@claremacrae
docs: Show use of temporary valuestask.file.frontmatter.tags & `tas…
9f4e3f5 
…k.file.tags`
@claremacrae
test: - Make 'kanban-plugin' filter work with all Kanban views
babcc78
@claremacrae
test: - Update CustomFilteringExamples.test.ts examples
bd7da05
@claremacrae
test: - Remove some docs examples that are no longer useful.
f9fd739
@claremacrae
test: - Update CustomGroupingExamples.test.ts examples
98d7468
@claremacrae
test: - Remove some repetition in a 'group by function' example
5aee7b2
@claremacrae
test: - Use continuation lines in 'group by function' example
c0552da
@claremacrae
test: - Remove use of task.file.property from snippet for docs
79307c5
@claremacrae
test: - Add an example multi-line string property
07e05fc
@claremacrae
docs: Update snippet in Task Properties.md
c59d16c
@claremacrae
docs: Work-in-progress commit of 'Obsidian Properties.md'
5d45e8c
@claremacrae
docs: Add properties search to What's New
d02a0e3
@claremacrae
docs: remove some unhelpful snippets from Obsidian Properties.md
b41b866
@claremacrae
docs: Show some example YAML and how it is interpreted
cc819c7
@claremacrae
docs: Remove references to task.file.tags, as the interface will like…
9d417bd 
…ly change...
@claremacrae
test: - Refactor verifyFieldDataFromTasksForReferenceDocs() to use a …
dd32607 
…loop

This is in preparation for allowing it to support only 1 task...
@claremacrae
test: - Reuse tasks variable
f50945b
@claremacrae
test: - Create table headings programmatically
d4dd374
@claremacrae
test: - Refactor verifyFieldDataFromTasksForReferenceDocs() to take T…
480c04b 
…ask[]
@claremacrae
docs: Remove useless examples of empty obsidian properties
39e1917
@claremacrae
docs: Try naming the properties docs Frontmatter Properties
c98c402
@claremacrae
docs: Try naming the properties docs Frontmatter Properties
47d2a17
@claremacrae
docs: Rename snippets to remove 'temp'
e695b31
@claremacrae claremacrae added scope: documentation Improvements or additions to documentation scope: parsing markdown See also 'scope: global filter' labels Jul 31, 2024
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Jul 31, 2024

Quality Gate Passed Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@claremacrae claremacrae merged commit 07e4e0b into main Jul 31, 2024
3 checks passed
@claremacrae claremacrae deleted the docs-access-properties branch July 31, 2024 22:20
@claremacrae claremacrae changed the title Docs access properties docs: Start documenting access to obsidian properties. Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
scope: documentation Improvements or additions to documentation scope: parsing markdown See also 'scope: global filter'
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@claremacrae