docs: add --field textarea multiline and underscore guidance

[Hinne1]

Summary

• Document \n for multiline textarea custom fields in --field
• Document expand section syntax (+++Title\ncontent\n+++)
• Add backtick guidance for code names with underscores (bare underscores render as italic in Jira)
• Add --field markdown auto-conversion example

Companion to enthus-appdev/atl-cli#42 which fixes the \n parsing.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the documentation for the atl issue edit command, specifically focusing on advanced usage of the --field option. The updates clarify how to handle multiline input for textarea custom fields, utilize expandable sections, ensure correct rendering of code names with underscores, and illustrate the automatic Markdown to ADF conversion for field values. These changes aim to improve user understanding and efficiency when interacting with Jira custom fields via the command-line interface.

Highlights

• Multiline Textarea Custom Fields: Documented the use of literal '\n' for creating multiline content within textarea custom fields when using the --field option.
• Expand Section Syntax: Added documentation for the +++Title\ncontent\n+++ syntax to create expandable sections within custom fields.
• Underscore Guidance for Code Names: Provided guidance on using backticks to correctly render code names containing underscores, preventing them from being interpreted as italics in Jira.
• --field Markdown Auto-conversion: Included an example demonstrating how Markdown text provided via the --field option is automatically converted to Atlassian Document Format (ADF).

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds valuable documentation for using multiline values and handling special characters in custom fields with the atl CLI. The examples for \n and expandable sections are clear. I've found a minor issue with escaping in one of the new documentation strings, which could cause it to render incorrectly. My feedback includes a suggestion to fix this.

[gemini-code-assist]

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!