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

latex: improve readme #1343

Merged
merged 2 commits into from
Apr 28, 2024
Merged

latex: improve readme #1343

merged 2 commits into from
Apr 28, 2024

Conversation

xiota
Copy link
Contributor

@xiota xiota commented Apr 28, 2024

Hoping this PR is quick to review and merge...

This moves info from ABOUT to README for the LaTeX plugin. This should make the plugin page more informative to potential users.

Also, deletes the ABOUT file from the latex, geanymacro, and geanynumberedbookmarks plugins because they duplicate the contents of README. These three plugins are the only ones with ABOUT files. According to grep, the files are not referenced by any others (eg, Makefile.am).

latex/README Show resolved Hide resolved
Copy link
Member

@b4n b4n left a comment

Choose a reason for hiding this comment

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

LGTM, indeed the ABOUTs don't seem useful, and for numberedbookmarks it's an old version of README including typos that have been corrected.

@b4n b4n requested a review from frlan April 28, 2024 18:07
@frlan frlan merged commit e00f819 into geany:master Apr 28, 2024
1 of 2 checks passed
@b4n b4n added this to the 2.1.0 milestone Apr 28, 2024
@xiota xiota deleted the pr_about branch April 29, 2024 02:51
@elextr
Copy link
Member

elextr commented Apr 29, 2024

@xiota exact formatting for READMEs doesn't matter so long as they render ok on plugins.geany.org which assumes ReST markup IIRC but I don't know how to see what the new version of the page looks like.

@xiota
Copy link
Contributor Author

xiota commented Apr 29, 2024

I added the new lines because it was easier for me to read the text version. I ran it through pandoc to preview, and saw no difference. But with a different parser or added stylesheet, there could be extra space between the items. Like the difference between:

<li>...</li>

<li><p>...</p></li>

@elextr
Copy link
Member

elextr commented Apr 29, 2024

Fine, both you and frlan prefer it so no problem, the source is only read by the developers, not the users.

IIRC rEsT (never remember the caPitaLization ;-) spaces list items independent of blank lines in the source, so should not matter.

The plugin pages in plugins.geany.org are made from the READMEs of the individual plugins. So these get CSS and surrounding content from the process that generates the pages.

So long as the ResT is valid and it looks ok in https://plugins.geany.org is all that matters. But as I said, I don't know how to check that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants