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.

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

Add note about messages going to stderr and the implication for piping #1768

Merged
merged 3 commits into from Jul 15, 2023

Conversation

micahellison
Copy link
Member

This PR adds a note in the "Data Formats" section of the docs about which data goes to stdout vs stderr.

While this is standard behavior for console apps, we have gotten a few issues about the record count messages appearing to interfere with piping because people weren't aware of this, so I'm hoping that this will help.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.

@micahellison micahellison added the documentation Improvements or additions to documentation label Jul 10, 2023
Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗒️

@micahellison micahellison merged commit c6b9114 into jrnl-org:develop Jul 15, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants