Skip to content

Add YARD documentation to source_prefix method - #101

Merged
f-ewald merged 3 commits into
feature/source-emojisfrom
copilot/sub-pr-100
Jan 14, 2026
Merged

Add YARD documentation to source_prefix method#101
f-ewald merged 3 commits into
feature/source-emojisfrom
copilot/sub-pr-100

Conversation

Copilot AI commented Jan 14, 2026

Copy link
Copy Markdown

The source_prefix method in LogEntryFormatters::BaseFormatter was missing YARD documentation while all other protected methods in the class had it.

Added documentation following the existing YARD style:

# Prefix emoji for the log entry based on its source.
# @param log_entry [LogEntry] The log entry to get the source prefix for.
# @return [String] The emoji prefix for the source (🐙 for github, ✍️ for manual, empty string otherwise).
def source_prefix(log_entry)
  # ...
end

This maintains consistency with the documentation patterns used in epic_prefix, metadata, and replace_people_handles.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 14, 2026 18:53
Co-authored-by: f-ewald <1391977+f-ewald@users.noreply.github.com>
Co-authored-by: f-ewald <1391977+f-ewald@users.noreply.github.com>
Copilot AI changed the title [WIP] Address feedback on adding emojis for different sources Add YARD documentation to source_prefix method Jan 14, 2026
Copilot AI requested a review from f-ewald January 14, 2026 18:56
@f-ewald
f-ewald marked this pull request as ready for review January 14, 2026 18:57
@github-actions

Copy link
Copy Markdown
Contributor

Code Coverage

Package Line Rate Complexity Health
worklog 79% 0
Summary 79% (743 / 944) 0

@f-ewald
f-ewald merged commit d9f4e17 into feature/source-emojis Jan 14, 2026
1 check passed
@f-ewald
f-ewald deleted the copilot/sub-pr-100 branch January 14, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants