Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
david-dick committed Jun 3, 2024
1 parent ff90465 commit 05f0325
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 12 deletions.
17 changes: 10 additions & 7 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ CONSTANTS
BCD_PATH

returns the local path used for storing the brower compability data for
the agent method when the <code>stealth</code> parameter is supplied to
the new method. This database is built by the build-bcd-for-firefox
binary.
the agent method when the stealth parameter is supplied to the new
method. This database is built by the build-bcd-for-firefox
<https://metacpan.org/pod/build-bcd-for-firefox> binary.

SUBROUTINES/METHODS

Expand Down Expand Up @@ -454,10 +454,13 @@ SUBROUTINES/METHODS
# Mozilla/5.0 (X11; Linux s390x; rv:109.0) Gecko/20100101 Firefox/115.0

If the stealth parameter has supplied to the new method, it will also
attempt to delete/provide dummy implementations for number of
javascript attributes <https://github.com/mdn/browser-compat-data> to
match the desired browser. The following websites have been very useful
in testing these ideas;
attempt to create known specific javascript functions to imitate the
required browser. If the database built by build-bcd-for-firefox
<https://metacpan.org/pod/build-bcd-for-firefox> is accessible, then it
will also attempt to delete/provide dummy implementations for the
corresponding javascript attributes
<https://github.com/mdn/browser-compat-data> for the desired browser.
The following websites have been very useful in testing these ideas;

* https://browserleaks.com/javascript

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This is a client module to automate the Mozilla Firefox browser via the [Marione

## BCD\_PATH

returns the local path used for storing the brower compability data for the [agent](#agent) method when the &lt;code>stealth&lt;/code> parameter is supplied to the [new](#new) method. This database is built by the build-bcd-for-firefox binary.
returns the local path used for storing the brower compability data for the [agent](#agent) method when the `stealth` parameter is supplied to the [new](#new) method. This database is built by the [build-bcd-for-firefox](https://metacpan.org/pod/build-bcd-for-firefox) binary.

# SUBROUTINES/METHODS

Expand Down Expand Up @@ -300,7 +300,7 @@ These parameters can be used to set a user agent string like so;
# user agent is now equal to
# Mozilla/5.0 (X11; Linux s390x; rv:109.0) Gecko/20100101 Firefox/115.0

If the `stealth` parameter has supplied to the [new](#new) method, it will also attempt to delete/provide dummy implementations for number of [javascript attributes](https://github.com/mdn/browser-compat-data) to match the desired browser. The following websites have been very useful in testing these ideas;
If the `stealth` parameter has supplied to the [new](#new) method, it will also attempt to create known specific javascript functions to imitate the required browser. If the database built by [build-bcd-for-firefox](https://metacpan.org/pod/build-bcd-for-firefox) is accessible, then it will also attempt to delete/provide dummy implementations for the corresponding [javascript attributes](https://github.com/mdn/browser-compat-data) for the desired browser. The following websites have been very useful in testing these ideas;

- [https://browserleaks.com/javascript](https://browserleaks.com/javascript)
- [https://www.amiunique.org/fingerprint](https://www.amiunique.org/fingerprint)
Expand Down
2 changes: 1 addition & 1 deletion build-bcd-for-firefox
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ Version 1.57
=head1 DESCRIPTION
This program is intended to build a database for the agent method of the Firefox::Marionette class. It builds this database by cloning the @mdn/browser-compat-data repository on github.com and then summarising this data for the agent method.
This program is intended to build a database for the agent method of the Firefox::Marionette class. It builds this database by cloning the L<@mdn/browser-compat-data|https://github.com/mdn/browser-compat-data> repository on github.com and then summarising this data for the agent method.
The path where the database is stored varies by user and operating system, and can be shown with the --path option.
Expand Down
4 changes: 2 additions & 2 deletions lib/Firefox/Marionette.pm
Original file line number Diff line number Diff line change
Expand Up @@ -12220,7 +12220,7 @@ This is a client module to automate the Mozilla Firefox browser via the L<Marion

=head2 BCD_PATH

returns the local path used for storing the brower compability data for the L<agent|/agent> method when the <code>stealth</code> parameter is supplied to the L<new|/new> method. This database is built by the build-bcd-for-firefox binary.
returns the local path used for storing the brower compability data for the L<agent|/agent> method when the C<stealth> parameter is supplied to the L<new|/new> method. This database is built by the L<build-bcd-for-firefox|https://metacpan.org/pod/build-bcd-for-firefox> binary.

=head1 SUBROUTINES/METHODS

Expand Down Expand Up @@ -12545,7 +12545,7 @@ These parameters can be used to set a user agent string like so;
# user agent is now equal to
# Mozilla/5.0 (X11; Linux s390x; rv:109.0) Gecko/20100101 Firefox/115.0

If the C<stealth> parameter has supplied to the L<new|/new> method, it will also attempt to delete/provide dummy implementations for number of L<javascript attributes|https://github.com/mdn/browser-compat-data> to match the desired browser. The following websites have been very useful in testing these ideas;
If the C<stealth> parameter has supplied to the L<new|/new> method, it will also attempt to create known specific javascript functions to imitate the required browser. If the database built by L<build-bcd-for-firefox|https://metacpan.org/pod/build-bcd-for-firefox> is accessible, then it will also attempt to delete/provide dummy implementations for the corresponding L<javascript attributes|https://github.com/mdn/browser-compat-data> for the desired browser. The following websites have been very useful in testing these ideas;

=over 4

Expand Down

0 comments on commit 05f0325

Please sign in to comment.