Skip to content

Add option to save snippet documentation #140

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

Closed
delphidabbler opened this issue Oct 23, 2024 · 5 comments
Closed

Add option to save snippet documentation #140

delphidabbler opened this issue Oct 23, 2024 · 5 comments
Assignees
Labels
completed Work has been completed on this issue and changes have been committed to `develop` branch.. feature request Request for a new feature

Comments

@delphidabbler
Copy link
Owner

Snippet documentation can currently be copied to the clipboard in either plain text or in RTF by using the Edit | Copy Information menu item. But the same information can't be saved to a file.

It would be useful if that could be done.

Furthermore Edit | Copy Information only copies the documentation for the currently selected snippet.

It would be useful if documentation could be output for the current snippet selection OR for the currently selected snippet.

Output in HTML format would be useful too.

Finally, to keep documentation as short as possible, the option to omit source code could be provided.

@delphidabbler delphidabbler self-assigned this Oct 23, 2024
@delphidabbler delphidabbler added feature request Request for a new feature considering Issue under consideration. May be accepted or rejected labels Oct 23, 2024
@github-project-automation github-project-automation bot moved this to Considering in CodeSnip Oct 23, 2024
@delphidabbler
Copy link
Owner Author

Finally, to keep documentation as short as possible, the option to omit source code could be provided.

A proposal similar to this for the Edit | Copy Information menu option has been added as separate issue #141.

@delphidabbler
Copy link
Owner Author

Output in HTML format would be useful too.

For ease of implementation it may be best to stick to RTF output if and when this is first implemented. If that implementation makes it to release then a new issue could be added to add the save as HTML option.

@delphidabbler
Copy link
Owner Author

Finally, to keep documentation as short as possible, the option to omit source code could be provided.

A proposal similar to this for the Edit | Copy Information menu option has been added as separate issue #141.

Issue #141 has been made a sub-issue of this issue.

@delphidabbler
Copy link
Owner Author

Implemented by merge commit 1b54e43

@delphidabbler delphidabbler added completed Work has been completed on this issue and changes have been committed to `develop` branch.. and removed considering Issue under consideration. May be accepted or rejected labels Apr 16, 2025
@delphidabbler delphidabbler moved this from Considering to Done - awaiting release in CodeSnip Apr 16, 2025
@delphidabbler
Copy link
Owner Author

All sub-issues removed since otherwise when this now-completed issue is closed it will still have open sub-issues.

The former sub-issues still exist as stand-alone issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed Work has been completed on this issue and changes have been committed to `develop` branch.. feature request Request for a new feature
Projects
Status: Done - awaiting release
Development

No branches or pull requests

1 participant