From bd74fefce24f1a9a7b6d3a7f1e17237a67e9d1d4 Mon Sep 17 00:00:00 2001 From: Štěpán Němec Date: Mon, 28 Aug 2023 12:42:46 +0200 Subject: Fix some typos/grammar/errors in docs and comments --- HACKING | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'HACKING') diff --git a/HACKING b/HACKING index df68b54d..18ec7420 100644 --- a/HACKING +++ b/HACKING @@ -7,7 +7,7 @@ It is archived at: https://public-inbox.org/meta/ and http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/ (using Tor) Contributions are email-driven, just like contributing to git -itself or the Linux kernel; however anonymous and pseudonymous +itself or the Linux kernel; nevertheless, anonymous and pseudonymous contributions will always be welcome. Please consider our goals in mind: @@ -15,17 +15,17 @@ Please consider our goals in mind: Decentralization, Accessibility, Compatibility, Performance These goals apply to everyone: users viewing over the web or NNTP, -sysadmins running public-inbox, and other hackers working public-inbox. +sysadmins running public-inbox, and other hackers working on public-inbox. We will reject any feature which advocates or contributes to any -particular instance of a public-inbox becoming a single point of failure. +particular instance of public-inbox becoming a single point of failure. Things we've considered but rejected include: * exposing article serial numbers outside of NNTP * allowing readers to inject metadata (e.g. votes) We care about being accessible to folks with vision problems and/or -lack the computing resources to view so-called "modern" websites. +lacking the computing resources to view so-called "modern" websites. This includes folks on slow connections and ancient browsers which may be too difficult to upgrade due to resource demands. @@ -45,7 +45,7 @@ Just-Ahead-of-Time-compiled C (via Inline::C) Do not recurse on user-supplied data. Neither Perl or C handle deep recursion gracefully. See lib/PublicInbox/SearchThread.pm and lib/PublicInbox/MsgIter.pm for examples of non-recursive -alternatives to previously-recursive algorithms. +alternatives to previously recursive algorithms. Performance should be reasonably good for server administrators, too, and we will sacrifice features to achieve predictable performance. @@ -61,8 +61,6 @@ on specific topics, in particular data_structures.txt Optional packages for testing and development --------------------------------------------- -Optional packages testing and development: - - Plack::Test deb: libplack-test-perl pkg: p5-Plack rpm: perl-Plack-Test @@ -107,6 +105,6 @@ Perl notes ---------- * \w, \s, \d character classes all match Unicode characters; - so write out class ranges (e.g "[0-9]") if you only intend to + so write out class ranges (e.g., "[0-9]") if you only intend to match ASCII. Do not use the "/a" (ASCII) modifier, that requires Perl 5.14 and we're only depending on 5.10.1 at the moment. -- cgit v1.2.3-24-ge0c7