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

Status: 2023q3: Wifibox: corrections, changes #270

Closed
wants to merge 5 commits into from

Conversation

grahamperrin
Copy link
Contributor

@grahamperrin grahamperrin commented Sep 29, 2023

Add the missing URL parts of the links lines.

Americanisation of the heading, consistent with past status reports.

Create subheadings for system requirements, and for features.

Make more use of normal paragraphs, less use of bullet points. Reorder things, to add clarity.

Conciseness and other suggested changes/corrections.

Add the missing URL parts of the links lines.

Americanisation of the heading, consistent with past status reports.

Create subheadings for system requirements, and for features.

Make more use of normal paragraphs, less use of bullet points.  Reorder
things, to add clarity.

Conciseness and other suggested changes.

Pull-request:	freebsd#270
Closes:		freebsd#270
Signed-off-by:	Graham Perrin <grahamperrin@gmail.com>
@grahamperrin
Copy link
Contributor Author

@pgj for your consideration. Thank you.

@grahamperrin grahamperrin marked this pull request as ready for review September 29, 2023 02:33
Copy link
Member

@lsalvadore lsalvadore left a comment

Choose a reason for hiding this comment

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

I approve the Links part (once the typo is fixed).

The rest should be approved by the original author @pgj.

@pgj
Copy link
Contributor

pgj commented Oct 2, 2023

Thank you. I am not sure I understand why it was necessary to change the text structure beyond style, formatting, and grammar fixes. For example, the description says "less use of bullet points" while it replaces the original 6 bullet points with 8. Is there a very specific style that is expected for the entries?

@lsalvadore
Copy link
Member

No @pgj, there is no very specific style expected beside what you can find at https://docs.freebsd.org/en/books/fdp-primer/writing-style/ and https://docs.freebsd.org/en/articles/freebsd-status-report-process/#_instructions_for_writers. @grahamperrin found the structure he proposed clearer and made a suggestion. You are free to reject it if you liked your original text more.

@pgj
Copy link
Contributor

pgj commented Oct 2, 2023

Sorry, it was not evident for me that this is a suggestion. My original pull request was closed and then I was thanked here for my consideration -- but nothing else.

If there is no other special consideration I should have complied, then yes, please keep my original structure of text. Do not get me wrong, I appreciate the effort but reading through the proposed version I was not convinced that it would offer the readers a better presentation on the topic. I thought that the changes were needed because how other reports look like.

@grahamperrin

This comment was marked as resolved.

Co-authored-by: Lorenzo Salvadore <developer@lorenzosalvadore.it>
@grahamperrin grahamperrin marked this pull request as draft October 2, 2023 11:16
@grahamperrin
Copy link
Contributor Author

(A very interesting project, by the way!)

With my previous commit, copy and paste resulted in loss of a line.
@grahamperrin

This comment was marked as resolved.

@pgj
Copy link
Contributor

pgj commented Oct 2, 2023

Sure, I am fine with changes in the grammar and changing the sentences themselves. (I am far from being a native English speaker with my Ugric linguistic heritage.) What I would prefer instead is that please do not change the order of the sentences and the composition (hence number) of the paragraphs.

freebsd-git pushed a commit that referenced this pull request Oct 5, 2023
Approved by:	pgj (report author)
Pull Request:	#270
@lsalvadore
Copy link
Member

Merged, thanks.

@lsalvadore lsalvadore closed this Oct 5, 2023
@grahamperrin
Copy link
Contributor Author

grahamperrin commented Oct 5, 2023

Sorry, I made final suggestions with GitHub not showing me the closure. (It was a draft, intentionally.)

If you're interested, 263c026

Jehops pushed a commit to Jehops/freebsd-doc that referenced this pull request Oct 23, 2023
Approved by:	pgj (report author)
Pull Request:	freebsd#270
Jehops pushed a commit to Jehops/freebsd-doc that referenced this pull request Oct 23, 2023
Approved by:	pgj (report author)
Pull Request:	freebsd#270
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants